Topic: Developer
GitLab Runner
Building a GitLab Runner Acquire a certificate that can be used by GitLab Runner. Needs to be a cert that can be registered in CONS3RT as a user. Follow this link for steps on creating a bot user with a machine certificate Create user in Arcus with the certificate Give user associated with the certificate the appropriate permissions in GitLab to register a Runner Go into GitLab and copy the GitLab Runner registration token Download the GitLab Runner - Certificate - Template Import asset using this article: Importing Your Asset Zip File Edit asset name and upload pem cert into media directory: Updating Software Assets Clone the GitLab Runner system (KB: Cloning Systems Scenarios and Deployments) Update system by swapping the certificate asset you created with the certificate asset template that you had in step 5 Create a scenario and a deployment In the deployment, include the following deployment properties: GITLAB_VERSION - The version of GitLab to use.
Building a GitLab Runner Acquire a certificate that can be used by GitLab Runner. Needs to be a cert that can be registered in CONS3RT as a user. Follow this link for steps on creating a bot user with a machine certificate Create user in Arcus with the certificate Give user associated with the certificate the appropriate permissions in GitLab to register a Runner Go into GitLab and copy the GitLab Runner registration token Download the GitLab Runner - Certificate - Template Import asset using this article: Importing Your Asset Zip File Edit asset name and upload pem cert into media directory: Updating Software Assets Clone the GitLab Runner system (KB: Cloning Systems Scenarios and Deployments) Update system by swapping the certificate asset you created with the certificate asset template that you had in step 5 Create a scenario and a deployment In the deployment, include the following deployment properties: GITLAB_VERSION - The version of GitLab to use.
CollabTools API
Interacting with the CollabTools API There are 4 overarching requirements to enable interaction with the CollabTools API: an active account for the CollabTool a personal access token for the CollabTool additional headers application specific permissions A reminder that PKI credentials are ALWAYS required no matter what authentication path (API or GUI) you use. Active Account You will need to have an active account in the CollabTool for which you want to make API calls.
Interacting with the CollabTools API There are 4 overarching requirements to enable interaction with the CollabTools API: an active account for the CollabTool a personal access token for the CollabTool additional headers application specific permissions A reminder that PKI credentials are ALWAYS required no matter what authentication path (API or GUI) you use. Active Account You will need to have an active account in the CollabTool for which you want to make API calls.
Using Git Client with CollabTools
Prerequisites Before trying to use a CAC or ECA with git, ensure you can first login successfully to GitLab or Bitbucket using a browser and the certificate you want to use with git. Windows Install Git Download Git for Windows Install using the default options Setup Git CAC Obtain your CAC Thumbprint. You can list certificates with the following powershell command: Get-ChildItem -path cert:\CurrentUser\My Replace {{ CAC Thumbprint }} with the thumbprint of your CAC in the commands below.
Prerequisites Before trying to use a CAC or ECA with git, ensure you can first login successfully to GitLab or Bitbucket using a browser and the certificate you want to use with git. Windows Install Git Download Git for Windows Install using the default options Setup Git CAC Obtain your CAC Thumbprint. You can list certificates with the following powershell command: Get-ChildItem -path cert:\CurrentUser\My Replace {{ CAC Thumbprint }} with the thumbprint of your CAC in the commands below.
Configuration and Teardown Scripts
What is a Configuration Script? A configuration script in Arcus is a shell script or Windows PowerShell script that can perform automated actions as part of the deployment process. In Arcus, there are two types of configuration scripts: master and host. Master configuration scripts are attached to the master node of your scenario, whereas host configuration scripts can be attached to each host in your scenario (including the master node).
What is a Configuration Script? A configuration script in Arcus is a shell script or Windows PowerShell script that can perform automated actions as part of the deployment process. In Arcus, there are two types of configuration scripts: master and host. Master configuration scripts are attached to the master node of your scenario, whereas host configuration scripts can be attached to each host in your scenario (including the master node).
Submission Service
Connecting your Arcus Project with an external provider using the Arcus Submission Service allows project members to push Assets and Container Images from Arcus to an external repository Setting up the Arcus Submission Service integration on a project requires a Arcus user account and is limited to owners of a Arcus project. Configuring the Submission Service Only a Project Owner can configure Submission Services for their project. If you’re not certain what your role is within a project, or don’t seem to have sufficient permissions, contact your Team Manager.
Connecting your Arcus Project with an external provider using the Arcus Submission Service allows project members to push Assets and Container Images from Arcus to an external repository Setting up the Arcus Submission Service integration on a project requires a Arcus user account and is limited to owners of a Arcus project. Configuring the Submission Service Only a Project Owner can configure Submission Services for their project. If you’re not certain what your role is within a project, or don’t seem to have sufficient permissions, contact your Team Manager.
Using Python with the ReST API
Try pycons3rtapi for an easy way to get started using the ReST API with Python 2.7. Prerequisites We suggest using the requests package to make ReST API calls with python, and the requests_toolbelt package to assist in calls using large file uploads like asset imports. Use pip to install prerequisites: pip install requests pip install requests_toolbelt Use an ECA Certificate with python Once requests is installed, you can leverage it to add your client ECA certificate to API requests to Arcus.
Try pycons3rtapi for an easy way to get started using the ReST API with Python 2.7. Prerequisites We suggest using the requests package to make ReST API calls with python, and the requests_toolbelt package to assist in calls using large file uploads like asset imports. Use pip to install prerequisites: pip install requests pip install requests_toolbelt Use an ECA Certificate with python Once requests is installed, you can leverage it to add your client ECA certificate to API requests to Arcus.
Make ReST API Calls with an ECA Cert
Set up Your Account to make ReST API Calls You can make ReST API calls using your Username, ECA certificate, and an API token To find your Username, click on the Profile Icon on the top-right, and select Profile & Account Click here for information on obtaining an ECA Certificate Register your ECA Certificate or Add an ECA Certificate to you existing Account Create an API Token Sample ReST API Calls on Linux In order to make ReST API calls on Linux, you may need to convert your ECA certificate (p12 or pfx file) to a PEM file with a private key.
Set up Your Account to make ReST API Calls You can make ReST API calls using your Username, ECA certificate, and an API token To find your Username, click on the Profile Icon on the top-right, and select Profile & Account Click here for information on obtaining an ECA Certificate Register your ECA Certificate or Add an ECA Certificate to you existing Account Create an API Token Sample ReST API Calls on Linux In order to make ReST API calls on Linux, you may need to convert your ECA certificate (p12 or pfx file) to a PEM file with a private key.
API Tokens
An API token is needed to access the Arcus ReST API on a per project basis. To create an API token: Generate a Project API Token Click on the person icon in the top right corner and select the “Profile & Account” option from the dropdown menu. Select Security and scroll down to API Tokens Click the Generate Token button next to the desired project. The token will appear and you will also receive a confirmation email.
An API token is needed to access the Arcus ReST API on a per project basis. To create an API token: Generate a Project API Token Click on the person icon in the top right corner and select the “Profile & Account” option from the dropdown menu. Select Security and scroll down to API Tokens Click the Generate Token button next to the desired project. The token will appear and you will also receive a confirmation email.