Skip to content

2 - Tracking your changes

When using the hpc-client in your environment, you may have to modify settings. Securely saving your settings in a git repository will prevent loss of data and allow for trackable changes on updating your version of the hpc-client.

You can track your changes in your favorite Git repository service:

a. GitHub instructions

  1. Create a new GitHub repository. Set it to private.

  2. Click "Settings" -> "Manage access" -> add any desired collaborators. At a minimum, whichever Flywheel staff member(s) you may be working with.

  3. Switch to the "Deploy keys" section, then generate a new ssh key on the terminal. Leave the passphrase blank:

    ssh-keygen -t ed25519 -C hpc-client-deploy-key -f ./hpc-client-deploy-key

cat hpc-client-deploy-key.pub

  4. Click "Add deploy key", and paste the public key's contents into the page. You may want to tick the box to give it write access also.

  5. Copy this key to your HPC for use later:

    scp hpc-client-deploy-key <your-hpc-host>:

  6. Choose a location to store your hpc-client credentials:

    cd <configuration directory>
git clone <The URL for the repository you created above> .

  7. Use this <configuration directory> in the Cluster Install step.

a. GitLab instructions

  1. Create a new GitLab repository. Set it to private.

  2. Click "Manage" -> "Members" -> add add any desired collaborators by clicking on the "Invite Members" button. In particular, whichever Flywheel staff member(s) you may be working with.

  3. If you don't have one already, add an SSH key to your GitLab profile to access the repository from the terminal. To generate a new token on your terminal, run (Leave the passphrase blank):

    ssh-keygen -t ed25519 -C hpc-client-deploy-key -f ./hpc-client-deploy-key

cat hpc-client-deploy-key.pub

  4. In GitLab, click on your Profile picture -> "Edit profile" -> "SSH Keys". Click "Add new key", and paste the public key's contents into the page. You need to give it at least "Authentication" permission; you may select "Authentication & Signing".

  5. Copy this key to your HPC for use later:

    scp hpc-client-deploy-key <your-hpc-host>:

  6. Choose a location to store your hpc-client credentials:

    cd <configuration directory>
git clone <The URL for the repository you created above> .

  7. Use this <configuration directory> in the Cluster Install step.