Asciisync

Asciisync performs a local asciibinder build and syncs the distribution of your choosing to a file server.

• Linux installation
  • Installing asciisync using a setup script (Linux)
  • Installing asciisync manually (Linux)
• Mac installation
  • Installing asciisync using a setup script (Mac)
  • Installing asciisync manually (Mac)
• Using Asciisync

Linux installation

Installing asciisync using a setup script (Linux)

Prerequisites

• You are using a Linux distribution
• You are on the VPN
• You have file.<geo> access
• You have a public_html directory in your file.<geo> server with 755 permissions:

  •   $ ssh <kerberos>@file.<geo>.redhat.com
      $ mkdir public_html
      $ chmod 755 public_html

• Optional: You have kinit configured NOTE: You will need to enter your kerberos password to authenticate if you do not have kinit configured and have obtaind a current kerberos ticket.

Procedure

1. Download the setup script here.

2. Make the file executable: NOTE: Your file may download in a different location.

   $ chmod 755 ~/Downloads/asciisync-setup.sh

3. Run the script:

   $ ./Downloads/asciisync-setup.sh

4. Provide your kerberos ID and file.<geo> when prompted, then press Enter:

   Enter your Kerberos ID:
   : 
   Enter your geo (rdu,emea,etc):
   :
   

5. Use asciisync.

Installing asciisync manually (Linux)

Prerequisites

• You are using a Linux distribution
• You are on the VPN
• You have file.<geo> access
• You have a public_html directory in your file.<geo> server with 755 permissions:

  •   $ ssh <kerberos>@file.<geo>.redhat.com
      $ mkdir public_html
      $ chmod 755 public_html

• Optional: You have kinit configured NOTE: You will need to enter your kerberos password to authenticate if you do not have kinit configured and have obtaind a current kerberos ticket.

Procedure

1. Create a file within your ~/bin called "asciisync": NOTE: I use vim as an editor. You may have nano, etc.

   $ vim ~/bin/asciisync

2. Paste the following text, then save and quit: IMPORTANT: Change the GEO=, and KERB= to your geographical region and kerberos ID.

   #!/bin/bash
   BRANCH=$(git branch --show-current)
   KERB=<kerberos>
   GEO=<geo>
   DISTRO_LIST=$(ls -1 _preview)
   podman run --rm -it -v `pwd`:/docs:Z quay.io/openshift-cs/asciibinder asciibinder clean
   podman run --rm -it -v `pwd`:/docs:Z quay.io/openshift-cs/asciibinder asciibinder build -l fatal
   echo "
   Which distribution would you like to preview?
   $DISTRO_LIST"
   read -p ": " DISTRO
   echo "Performing the rsync."
   rsync -az --rsync-path="mkdir -p ~/public_html/$BRANCH/* && rsync" --info=progress2 --human-readable _preview/$DISTRO/$BRANCH/* $KERB@file.$GEO.redhat.com:~/public_html/$BRANCH
   echo "
   Complete!
   
   URL: http://file.$GEO.redhat.com/$KERB/$BRANCH/welcome"
   

3. Make the file executable:

   $ chmod 755 ~/bin/asciisync

4. Use asciisync.

Mac installation

Installing asciisync using a setup script (Mac)

Prerequisites

• You are using MacOS

Procedure

1. Install homebrew.
2. Brew install podman
3. Brew install shellcheck-py
4. Brew install shellcheck
5. shellcheck
6. shell
7. Download asciisync-mac
8. chmod +x asciisync-mac
9. ./asciisync-mac
10. script needs mv /usr/local/bin/asciisync
11. podman machine init
12. podman machine start
13. cd openshift docs
14. asciisync

Installing asciisync manually (Mac)

Prerequisites

• You are using MacOS

Procedure

1. Install homebrew.
2. Brew install podman
3. Brew install shellcheck-py
4. Brew install shellcheck
5. shellcheck
6. shell
7. vim /usr/local/bin/asciisync and paste file contents
8. chmod 755 asciisync
9. podman machine init
10. podman machine start
11. cd openshift docs
12. asciisync

Using asciisync

Prerequisites

• You are on the VPN
• You have file.<geo> access
• You have a public_html directory in your file.<geo> server with 755 permissions:

  •   $ ssh <kerberos>@file.<geo>.redhat.com
      $ mkdir public_html
      $ chmod 755 public_html

• Optional: You have kinit configured NOTE: You will need to enter your kerberos password to authenticate if you do not have kinit configured and have obtaind a current kerberos ticket.

Asciisync is configured to build all possible distributions and will upload the distribution of your choosing.

1. Change directory to the git branch that you want to preview: NOTE: Your openshift-docs repository may installed in another location.

   $ cd ~/openshift-docs/

2. Run asciisync:

   $ asciisync

3. Choose the disribution you wish to preview. Type your response and press Enter.

   Which distribution would you like to preview?
   microshift
   openshift-dedicated
   openshift-enterprise
   openshift-rosa
   openshift-rosa-portal
   : 
   

4. The script completes, providing a URL. Ctrl + left click on the URL to open in your browser.

   Complete!
   
   URL: http://file.<geo>.redhat.com/<kerb>/<branch>/welcome"