AWS CodeCommit Version Control

This document guides you in configuring your AWS CodeCommit repository with your Insites Instance.

Prerequisites

Steps

------------------------------------------------------------------------------------------------------------------------------------------

------------------------------------------------------------------------------------------------------------------------------------------

------------------------------------------------------------------------------------------------------------------------------------------

Getting to know the Version Control UI

1. This toggle switch will enable / disable the Version Control feature for the Site Manager’s Pages, Content Blocks and Templates.
2. This is your site's Instance URL. This is an auto-filled field and cannot be edited.
3. This is your repository’s SSH URL, you can get this after step 1 of the initial setup.
4. This is your PlatformOS Account token that can be generated with the pOS-CLI tool. Please see the details below to learn how to generate it.

1. Git Repository Setup and SSH Authentication

1. Create a repository. For CodeCommit users please follow the AWS documentation - https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-repository.html
2. Download and Install Git on your machine from their website - https://git-scm.com/
3. Create SSH keys without a passphrase. For CodeCommit users please follow their documentation for
   - MacOS / Linux - https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-unixes.html
   - Windows - https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-windows.html

2. Admin Setup - pOS CLI Token

1. Install the PlatformOS CLI Tool - https://www.npmjs.com/package/@platformos/pos-cli
2. Go to the pOS partner portal - https://partners.platformos.com/
3. Go to your instance and then copy the command to create an environment as shown in the image below.
   
4. Open a Terminal, then paste the command and hit ‘Enter’. It will ask for your pOS Account password for verification. Please enter it.
   
5. Upon successfully creating the environment, open the “.pos” file on your local machine, and you will see your pOS-CLI Token.
   

3. Admin Setup - Configure a User

In order to use the Version Control features, you must configure a user.

1. Select the admin user you wish to configure from the dropdown menu.
2. This field will show if your repository is from CodeCommit. Please enter the SSH Key ID generated from the Initial Setup, you can check it on the user’s IAM account. It is highlighted in red in the image below.
   
3. SSH Private key is the pair of the public key you uploaded in the repositories from the Initial Setup. Usually this is the file without the “.pub” extension (see image below), open this file in a text editor, do a select all, copy and paste it into the field. Please note that SSH keys should not have a passphrase otherwise it will cause an error upon adding the user.