Appendix

Topics

To access content stored on GitHub, your GitHub account must have credentials associated to your account. Two options are available:

  1. GitHub Credentials

  2. Bitwarden

  3. SSH Key Generation

The following sections will describe how to configure your GitHub account with these credential types.

GitHub Credentials

SSH

To enable access to GitHub using SSH Keys ensure that an SSH key pair is available for use. If a keypair is not currently available, follow the steps found here.

cat ~/.ssh/id_rsa.pub

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQC5uBNhGE8fsGFzVdmQ0Rq8DEZWU5VomjapuWYqHqenUCnU+9lPh8Z6dXdYf6/86Ou9eRfPMpKvBdwjGgybb/4Wl9/BlRo7F3IUlALrDOELoT0u7vo2GvG0er9Hr5hPQL9pvTD5fNfnCcUyF4nM/4EH6yoUTA9trpYp02i8jzxmnD855lCk1pqmnbqTMdFsT8hcKeqnjsHLTXrEr5/wyMiKsNcqmq/iThIRWISRA/VGRh7RoK+NA6I1dcEN47bYv8siaPzeQbI72yTVyvYXGYsQIY5+G0HDWdOTjSFmYG3a1/Rkp4wvagj3VEzBndi/dlis6gewuVJUPifiikQp50id0vJJ02YOAePWipIHvSd8qyICBxo7jpt9zXhw/nI3YysfBUzKwxSgIVpQ4RMRTpOnXoPN013XXMluEz2z0yknKW1ai1IW+XvY4GCHHFj/ZkghyyE9O4Qnb9EJD4kezKww9IaP/95PPjps9osDsWmxiUDx3G2aPWysOnuN4T4TMqGZYmJNMQaSSuIn8JDQn9EMVWCFRs6WdO1fusdNSDzZmhe0zMqjIi6g3OGQoRjgMSidJL7fzi/ENNVe0IHkYdQe+/JJ2uD4hiEMBWgYtzaObUW5xfmVpT9LsmWvDqxpGgR4EAYSLIZRwUoILK8ekCxeOBoKKyA9P98dc8fPAcTJLQ== jdoe@redhat.com

Login to GitHub and navigate to the SSH and GPG keys section of your Settings by clicking here.

Click the New SSH key button to begin the configuration process.

Paste the contents of the SSH Public Key previously copied in the Key text field. Include an optional Title to distinguish the key from other keys, and select the desired Key type (The default option Authentication Key is satisfactory).

Click the Add SSH key button to add the SSH Public Key to your account. You may be prompted to confirm your GitHub password.

To verify that you can successfully communicate with GitHub using the SSH key configured in your account, execute the following command.

ssh -T git@github.com

If this is the first time you are connecting to GitHub, you will receive a warning indicating that you need to verify the authenticity of the host. Type yes and hit Enter.

The following message will be displayed indicating a successful connection to the GitHub server.

Hi jdoe! You've successfully authenticated, but GitHub does not provide shell access.

Personal Access Token

A GitHub Personal Access Token (PAT) can be used instead of SSH keys to authenticate to GitHub.

Login to GitHub and navigate to the Developer settings → Personal access tokens section of your Settings by clicking here.

Click the Generate new token button to begin the configuration process.

Enter a Note for the Personal Access Token (such as openshift-virtualization-migration) and optionally select an Expiration date.

Under the Select scopes section, select repo to grant the required repository access.

Click Generate token to create the token.

A confirmation page will be displayed and includes the value of the generated token. Be sure to copy the value as it cannot be accessed after the page is closed.

GitHub repositories can now be accessed using the HTTPS protocol.

Bitwarden

Bitwarden is used to store sensitive resources for the Ansible for OpenShift Virtualization Migration Project and are located in a Bitwarden Collection. To gain access to the collection, you must have a Bitwarden account associated with your @redhat.com Email Address.

Use the following steps to complete the setup process.

  1. Create a Bitwarden account using your Red Hat email address

  2. Join the migration-factory Google Group. The easiest way to join the Google Group is to onboard to the Ansible for OpenShift Virtualization Migration using this form.

  3. Download one of the supported applications or use the Bitwarden website to access the resources that are available to you.

Once the membership to the migration-factory Google Group has been confirmed, it may take some time until the Bitwarden Collection called Migration Factory is available.

When the synchronization has completed, the Migration Factory Collection should be present under the Collection section of the Bitwarden Vault.

SSH Key Generation

An SSH Key can be used to facilitate the communication between a local machine or the Ansible for OpenShift Virtualization Migration to external tools. The ssh-keygen command is used to create an SSH keypair for this purpose.

Create a new SSH keypair of type rsa. An example of the steps for generating the keypair is shown below. Be sure to update the email address associated with the -C parameter with your actual email address:

ssh-keygen -t rsa -b 4096 -C jdoe@redhat.com

Generating public/private rsa key pair.
Enter file in which to save the key (/home/jdoe/.ssh/id_rsa):
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in /home/jdoe/.ssh/id_rsa
Your public key has been saved in /home/jdoe/.ssh/id_rsa.pub
The key fingerprint is:
SHA256:pKRsBjinOgW2jx76Ba36FG4Ap+V1/vqz76gE2alMThw jdoe@redhat.com
The key's randomart image is:
+---[RSA 4096]----+
|                 |
| .               |
|=.= E o .        |
|oX.* O +         |
|+.= % = S        |
|.+o@ o .         |
|oo=.= . .        |
|o=.. . ...       |
|o+o   oo+=o      |
+----[SHA256]-----+