Downloading your Genesys Engage containers

From Genesys Documentation
Jump to: navigation, search

Genesys Engage containers are accessible through JFrog. You can also automate downloads to set up a Continuous Delivery (CD) pipeline.

Early Adopter Program
Genesys Engage cloud private edition is being released to pre-approved customers as part of the Early Adopter Program. Please note that the documentation and the product are subject to change. For more details about the program, please contact your Genesys representative.

Overview

Genesys uses JFrog to deliver and distribute its release containers. JFrog is a hybrid, universal, end-to-end devops platform. It is a fully automated platform for distributing software releases from code to production. You can pull new releases from the JFrog Artifactory Edge repository.

Use the information in this topic to set up your Continuous Delivery (CD) pipeline.
Important
Your CD pipeline must accommodate any necessary steps to meet your corporate requirements such as, performing security scans and validation testing.
The Engage private edition release containers can be accessed through either of the following:
  • Artifactory Edge Portal
  • Artifactory Edge API
  • Command Line Interfaces (CLI) for Docker, Helm, or cURL.

You can set up automated downloads for any of the available repositories using the Set Me Up screen for the corresponding repository.

Accessing repositories on JFrog

  1. Navigate to the following URL using your browser:
    https://pureengageuse1.jfrog.io/ui/login/
  2. Use your JFrog credentials from Genesys to log in.
Important
Credentials to access the Genesys repository on JFrog are automatically emailed to new accounts. Please contact your Genesys Account Representative if you have not received your credentials.
JFrogWelcome.png

Artifactory Edge contains the following six Genesys repositories:
Important
A virtual repository aggregates several repositories with the same package type under a common URL.
Name of repository Type of artifacts
helm-premise-local Helm charts local repository​
files-config-docker-premise-local​ Configuration files local repository​
docker-premise-local​ Docker local repository​
helm-premise​ Helm virtual repository​
files-config-docker-premise​ Files virtual repository​
docker-premise​ Docker virtual repository​

Once you login, select Artifacts from the Artifactory Edge menu from the left pane. All repositories available for download from Genesys are listed.JFrogEdgeRep.png

You can expand each repository and navigate to any of the files within a folder to view its properties on the left pane. Note that as all available files are listed, you must navigate to the one you require based on the date and version number.

JFrogEdgeRep2.png

The Distribution view lists all files IPs and the files within each IP.

JFrogDistView.png

You can set up automated downloads for any repository using the Set Me Up screen for the corresponding repository.

Signing up for update notifications

When you log in for the first time, sign up for email notifications on any updates to the packages in the repository. Note that you can set this up later too. But we recommend you set this up in order to receive regular notifications on any updates to the packages.

  1. Click on your username at the top right corner of the screen.
  2. Select the Edit Profile option from the drop-down.
    UpdNot1.png
  3. Enter your password and click Unlock.
    UpdNot2.png
  4. Verify your email address. Update if required and click Save.
    UpdateNot3.png
  5. Navigate to the repository for which you want update notifications.
  6. Click Actions at the top right corner, and then click Follow from the drop-down.
    UpdNot4.png
    A confirmation message is displayed.
    UpdNot5.png

Important
Update notifications are accumulated across 1-minute intervals and sent in a single email.

Setting up automated downloads

You can integrate with external tools to automate your downloads from JFrog. The Set Me Up screen provides quick access to information on how to configure your different clients to work with the corresponding repositories you have created.

  • Select a repository and click Set Me Up on the top right corner to view its Set Me Up screen​.
    SetMeUp1.png
    SetMeUp2.png


Downloading using Docker CLI

  1. On the Set Me Up screen, select Docker from the Package Type drop-down.
    Docker.png
  2. Provide the following docker login command in the General section as shown below:
    docker login pureengageuse1-docker-premise.jfrog.io
  3. Provide your Artifactory username and password or the API key in the provided input field.
  4. To manually set your credentials, or if you are using Docker v1, copy the following snippet to your ~/.docker/config.json file:
    {
    	"auths": {
    	"https://pureengageuse1-docker-premise.jfrog.io" : {
    "auth": "<USERNAME>:<PASSWORD> (converted to base 64)", "email": "youremail@email.com"
    		}
    	}
    }

  5. To pull an image use the docker pull command specifying the docker image and tag names:
    docker pull pureengageuse1-docker-premise.jfrog.io/<DOCKER_REPOSITORY>:<DOCKER_TAG>

Downloading using the Helm CLI

To work with Helm repositories, you must have a Helm client installed and configured before you perform the following steps:
Important
You must use Helm version 2.9.0 or a higher version that supports authentication against Artifactory.​
  1. On the SET ME UP screen, select Helm from the Package Type drop-down.
    Helm.png
  2. In the General section, set up your default Artifactory Helm repository/registry with the following command:
    helm repo add helm-premise https://pureengageuse1.jfrog.io/artifactory/helm-premise --username <USERNAME> --password <PASSWORD>
  3. In the Resolve section, provide the following commands to install a Helm Chart from the selected repository using your Helm command line client:
    helm repo update
    helm install helm-premise/[chartName]

Downloading using cURL

You can also download a package from the Edge Artifactory by accessing its API through a cURL command.

For example,

curl -utest-use1edge:AP3joWh1WJkH39WbiGmvMUBCBD8 -O "https://pureengageuse1.jfrog.io/artifactory/helm-premise/cxcontact-022.03.121.tgz"​.

Downloading manually

JFrog Artifactory also supports manual downloads if you do not want to set up a CD pipeline.

  1. Select the required artifact using the Tree browsing method or the Simple browsing method.
  2. Click the Deploy option on the top right corner of the screen.
    ManualDownload.png

For more information on browsing through the artifacts in the Artifact Repository Browser, refer to the Browsing Artifacts topic on the JFrog documentation site.

Additional reading material

  • JFrog Artifactory Edge (an Edge node) is an edition of JFrog Artifactory with features customized to serve the primary purpose of distributing software to a runtime system such as a data center, a point-of-sale, or even a mobile device.
    For more information, refer to the JFrog Artifactory Edge topic on the JFrog documentation site.
  • Local repositories are physical, locally-managed repositories into which you can deploy artifacts. Whereas, a virtual repository (or repository group) aggregates several repositories with the same package type under a common URL.
    For more information, refer to the Repository Management topic on the JFrog documentation site.