Skip to content
This repository has been archived by the owner on Jul 12, 2024. It is now read-only.

Latest commit

 

History

History
72 lines (51 loc) · 2.71 KB

development.md

File metadata and controls

72 lines (51 loc) · 2.71 KB

Development

This integration focuses on JFrog Artifactory and is using JFrog Artifactory REST API for interacting with the JFrog Artifactory platform.

Provider account setup

Cloud JFrog Artifactory Setup

To set up a JFrog Artifactory account, please follow these steps:

  1. Visit the JFrog Sign Up page, select "Cloud" and submit the form/follow through with the procedure.
  2. Once done, you will receive an email containing your account information and a link ([your organization].jfrog.io) to the dashboard for your organization.

Authentication

  1. Once logged in, navigate to the "Administrator" section by clicking on the cog looking button on the top left side.

Administrator section

  1. Next you need to select "Identity And Access" panel and select the "Access Tokens" sub-menu item.

Access tokens

  1. To create an access token you need to click "+ Generate Admin Token" button found on the top right. After a new modal appears, make sure Artifactory is selected and set the expiration based on your needs. Then click "Generate".

Generate admin token

  1. A new modal will appear containing the access token. It is shown only once, so make sure to save it somewhere or you'll need to re-create it again later.

  2. Copy the API Key, create a .env file at the root of this project, and set the CLIENT_ACCESS_TOKEN variable with the copied value.

CLIENT_ACCESS_TOKEN="paste the access token value here"
  1. The next step is to include the hostname in the .env file. Put the host part of the URL that you received from the email that you received from JFrog ([this part].jfrog.io).
CLIENT_ACCESS_TOKEN="paste the access token value here"
CLIENT_NAMESPACE="your organization name"
  1. The final step is to also include the pipeline access token. Creation process is similar, you just make sure that the "Pipelines" service is selected on the modal after you click on the "+ Generate Admin Token" button on the same Access Tokens page.

Generate pipeline token

CLIENT_ACCESS_TOKEN="paste the access token value here"
CLIENT_NAMESPACE="your organization name"
CLIENT_PIPELINE_ACCESS_TOKEN="paste the pipeline token generated from the previous step here"

After following the above steps, you should now be able to start contributing to this integration. The integration will pull in the CLIENT_ACCESS_TOKEN and CLIENT_NAMESPACE variables from the .env file and use them when making requests.