How to use JFrog Artifactory to download dependencies from private repositories?

How Do I?
, , ,
1

I want to use JFrog Artifactory for managing the company’s private dependencies. During an okteto up session I want my dev container to be able to install dependencies from private repositories using Maven, npm., Go, pip, etc. How can I achieve that?

2

To allow your Okteto dev containers to pull dependencies from private repositories, you need to authenticate with JFrog Artifactory when running okteto up.

To authenticate with JFrog you need to make the JFrog credentials available to the dev containers and instruct your package manager to use the credentials.

To make the credentials safely available to the dev container you can use Okteto Variables and configure the environment property of the Okteto Manifest to pass the value to the container.

Example:

  1. Create the following Okteto Variables:

    • ARTIFACTORY_SERVER_DOMAIN
    • ARTIFACTORY_API_KEY

  2. Modify your okteto.yml and configure your dev container to use them:

dev:
  app:
    environment:
      ARTIFACTORY_SERVER_DOMAIN: ${ARTIFACTORY_SERVER_DOMAIN}
      ARTIFACTORY_ACCESS_TOKEN: ${ARTIFACTORY_ACCESS_TOKEN}
  1. Depending on the package manager used, refer to the JFrog documentation on how to authenticate, for example here are some links to common ones:

To authenticate automatically when the dev container starts, you can use the command property of the Okteto Manifest.

As an example, for JavaScript or TypeScript projects using npm, yarn or any other npm-compatible package manager, you can use this command:

dev:
  app:
    environment:
      ARTIFACTORY_SERVER_DOMAIN: ${ARTIFACTORY_SERVER_DOMAIN}
      NPM_TOKEN: ${ARTIFACTORY_ACCESS_TOKEN}
    command: |
     echo "//${ARTIFACTORY_SERVER_DOMAIN}/:_authToken=\${NPM_TOKEN}" >> ~/.npmrc
     npm install
     npm start

What this command does, is to create a .npmrc file in your dev container’s home directory.

This file is used internally by npm to authenticate your requests to the npm registry.

By having access to the ARTIFACTORY_SERVER_DOMAIN environment variable, it will automatically expand that, pointing to your JFrog Artifactory server. For security reasons, we don’t want to hard-code the token in the file, so npm implements a special variable called NPM_TOKEN (see docs) that will be replaced internally by npm when you install a package.

For this reason we’ve exported the NPM_TOKEN environment variable in our manifest, passing the value from ARTIFACTORY_ACCESS_TOKEN.

3 Likes