PrivateEdition/Current/PEGuide/ManageServices - Revision history

WikiSysop at 07:00, May 23, 2024

2024-05-23T07:00:27Z

WikiSysop at 09:00, July 22, 2022

2022-07-22T09:00:43Z

WikiSysop at 13:45, May 7, 2022

2022-05-07T13:45:28Z

WikiSysop at 08:30, April 1, 2022

2022-04-01T08:30:40Z

MPandian: Published

2022-03-22T14:17:48Z

Published

Ed.jamer@genesys.com: Text replacement - "Genesys Engage" to "Genesys Multicloud CX"

2021-11-09T21:13:51Z

Text replacement - "Genesys Engage" to "Genesys Multicloud CX"

Uma.jayakumar@genesys.com: Published

2021-06-30T18:51:09Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Downloading your Genesys Engage containers
|Context=Genesys Engage containers are accessible through JFrog. You can also automate downloads to set up a Continuous Delivery (CD) pipeline.
|ComingSoon=No
|Platform=Private Edition
|Section={{Section
|sectionHeading=Overview
|anchor=ovrvw
|alignment=Vertical
|structuredtext=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.{{NoteFormat|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.
|Status=No
}}{{Section
|sectionHeading=Accessing repositories on JFrog
|anchor=accjf
|alignment=Vertical
|structuredtext=#Navigate to the following URL using your browser: https://pureengageuse1.jfrog.io/ui/login/
#Use your JFrog credentials from Genesys to log in.
{{NoteFormat|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.|}}[[File:JFrogWelcome.png|border|700x700px]] Artifactory Edge contains the following six Genesys repositories:{{NoteFormat|A virtual repository aggregates several repositories with the same package type under a common URL.|}}
{{{!}} class="wikitable"
{{!}}+
!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.[[File:JFrogEdgeRep.png|border|700x700px]]

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.

[[File:JFrogEdgeRep2.png|border|700x700px]]

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

[[File:JFrogDistView.png|border|700x700px]]

You can set up automated downloads for any repository using the '''Set Me Up''' screen for the corresponding repository.
|Status=No
}}{{Section
|sectionHeading=Signing up for update notifications
|anchor=sgnupdnot
|alignment=Vertical
|structuredtext=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.

#Click on your username at the top right corner of the screen.
#Select the '''Edit Profile''' option from the drop-down. [[File:UpdNot1.png|border|700x700px]]
#Enter your password and click '''Unlock'''. [[File:UpdNot2.png|border|700x700px]]
#Verify your email address. Update if required and click '''Save'''. [[File:UpdateNot3.png|border|700x700px]]
#Navigate to the repository for which you want update notifications.
#Click '''Actions''' at the top right corner, and then click '''Follow''' from the drop-down. [[File:UpdNot4.png|border|700x700px]] A confirmation message is displayed. [[File:UpdNot5.png|border|700x700px]] 
{{NoteFormat|Update notifications are accumulated across 1-minute intervals and sent in a single email.|}}
|Status=No
}}{{Section
|sectionHeading=Setting up automated downloads
|anchor=setupautdown
|alignment=Vertical
|structuredtext=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. [[File:SetMeUp1.png|border]] [[File:SetMeUp2.png|border]]

 

===Downloading using Docker CLI===

#On the '''Set Me Up''' screen, select '''Docker''' from the '''Package Type''' drop-down. [[File:Docker.png|border]]
#Provide the following docker login command in the '''General''' section as shown below: <code>docker login pureengageuse1-docker-premise.jfrog.io</code>
#Provide your Artifactory username and password or the API key in the provided input field.
#To manually set your credentials, or if you are using Docker v1, copy the following snippet to your '''~/.docker/config.json''' file: <source>{
"auths": {
"https://pureengageuse1-docker-premise.jfrog.io" : {
"auth": "<USERNAME>:<PASSWORD> (converted to base 64)", "email": "youremail@email.com"
}
}
}</source> 
#To pull an image use the docker pull command specifying the docker image and tag names: <code>docker pull pureengageuse1-docker-premise.jfrog.io/<DOCKER_REPOSITORY>:<DOCKER_TAG></code>

===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:{{NoteFormat|You must use Helm version 2.9.0 or a higher version that supports authentication against Artifactory.|}}

#On the '''SET ME UP''' screen, select '''Helm''' from the '''Package Type''' drop-down. [[File:Helm.png|border]]
#In the '''General''' section, set up your default Artifactory Helm repository/registry with the following command: <code>helm repo add helm-premise <nowiki>https://pureengageuse1.jfrog.io/artifactory/helm-premise</nowiki> --username <USERNAME> --password <PASSWORD></code>
#In the '''Resolve''' section, provide the following commands to install a Helm Chart from the selected repository using your Helm command line client: <code>helm repo update</code> <code>helm install helm-premise/[chartName]</code>
|Status=No
}}{{Section
|sectionHeading=Downloading using cURL
|anchor=downcurl
|alignment=Vertical
|structuredtext=You can also download a package from the Edge Artifactory by accessing its API through a cURL command.

For example,

<code>curl -utest-use1edge:AP3joWh1WJkH39WbiGmvMUBCBD8 -O "[https://pureengageuse1.jfrog.io/artifactory/helm-premise/cxcontact-022.03.121.tgz" https://pureengageuse1.jfrog.io/artifactory/helm-premise/cxcontact-022.03.121.tgz"]</code>.
|Status=No
}}{{Section
|sectionHeading=Downloading manually
|anchor=downman
|alignment=Vertical
|structuredtext=JFrog Artifactory also supports manual downloads if you do not want to set up a CD pipeline.

#Select the required artifact using the ''Tree'' browsing method or the ''Simple'' browsing method.
#Click the '''Deploy''' option on the top right corner of the screen. [[File:ManualDownload.png|border]]

For more information on browsing through the artifacts in the Artifact Repository Browser, refer to the [https://www.jfrog.com/confluence/display/JFROG/Browsing+Artifacts Browsing Artifacts] topic on the JFrog documentation site.
|Status=No
}}{{Section
|sectionHeading=Additional reading material
|anchor=addreadmat
|alignment=Vertical
|structuredtext=*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 [https://www.jfrog.com/confluence/display/JFROG/JFrog+Artifactory+Edge 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 [https://www.jfrog.com/confluence/display/JFROG/Repository+Management Repository Management] topic on the JFrog documentation site.
|Status=No
}}
}}

@@ Line 9: / Line 9: @@
 |anchor=ovrvw
 |alignment=Vertical
-|structuredtext=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.
+|structuredtext=
 Use the information in this topic to set up your Continuous Delivery (CD) pipeline.{{NoteFormat|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:
@@ Line 50: / Line 53: @@
 {{!}}}
-Once you login, select '''Artifacts''' from the '''Artifactory Edge''' menu from the left pane. All repositories available for download from Genesys are listed.[[File:JFrogEdgeRep.png|border|700x700px]]
+Once you log in, select '''Artifacts''' from the '''Artifactory Edge''' menu from the left pane. All repositories available for download from Genesys are listed.[[File:JFrogEdgeRep.png|border|700x700px]]
 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.
@@ Line 89: / Line 92: @@
 #On the '''Set Me Up''' screen, select '''Docker''' from the '''Package Type''' drop-down.<br />[[File:Docker.png|border]]
-#Provide the following docker login command in the '''General''' section as shown below:<br /> <code>docker login pureengageuse1-docker-premise.jfrog.io</code>
+#Provide the following docker login command in the '''General''' section as shown below:<br /> <code>docker login pureengageuse1-docker-multicloud.jfrog.io</code>
-#Provide your Artifactory username and password or the API key in the provided input field.
+#Provide your Artifactory username and password or the API key in the provided input field.{{NoteFormat|You can set up your API key from the '''Edit Profile''' option.|}}<br />
 #To manually set your credentials, or if you are using Docker v1, copy the following snippet to your '''~/.docker/config.json''' file:<br /><source>{
 	"auths": {
-	"https://pureengageuse1-docker-premise.jfrog.io" : {
+	"https://pureengageuse1-docker-multicloud.jfrog.io" : {
 "auth": "<USERNAME>:<PASSWORD> (converted to base 64)", "email": "youremail@email.com"
+		}
+	}
 }</source><br />
-#To pull an image use the docker pull command specifying the docker image and tag names:<br /> <code>docker pull pureengageuse1-docker-premise.jfrog.io/<DOCKER_REPOSITORY>:<DOCKER_TAG></code>
+#To pull an image use the docker pull command specifying the docker image and tag names:<br /> <code>docker pull pureengageuse1-docker-multicloud.jfrog.io/<DOCKER_REPOSITORY>:<DOCKER_TAG></code>{{NoteFormat|Tagging allows you to group related container images together.|}}
 ===Downloading using the Helm CLI===
@@ Line 104: / Line 107: @@
 #On the '''SET ME UP''' screen, select '''Helm''' from the '''Package Type''' drop-down.<br /> [[File:Helm.png|border]]
-#In the '''General''' section, set up your default Artifactory Helm repository/registry with the following command:<br /> <code>helm repo add helm-premise <nowiki>https://pureengageuse1.jfrog.io/artifactory/helm-premise</nowiki> --username <USERNAME> --password <PASSWORD></code>
+#In the '''General''' section, set up your default Artifactory Helm repository/registry with the following command:<br /> <code>helm repo add helm-multicloud <nowiki>https://pureengageuse1.jfrog.io/artifactory/helm-multicloud</nowiki> --username <USERNAME> --password <PASSWORD></code>
-#In the '''Resolve''' section, provide the following commands to install a Helm Chart from the selected repository using your Helm command line client:<br /> <code>helm repo update</code><br /> <code>helm install helm-premise/[chartName]</code>
+#In the '''Resolve''' section, provide the following commands to install a Helm Chart from the selected repository using your Helm command line client:<br /> <code>helm repo update</code><br /> <code>helm install helm-multicloud/[chartName]</code>
 |Status=No
 }}{{Section
@@ Line 115: / Line 118: @@
 For example,
-<code>curl -u<username>:<apitoken> -O "[https://pureengageuse1.jfrog.io/artifactory/helm-premise/cxcontact-022.03.121.tgz&#x22; https://pureengageuse1.jfrog.io/artifactory/helm-premise/cxcontact-022.03.121.tgz"]</code>.
+<code>curl -u<username>:<apitoken> -O "[https://pureengageuse1.jfrog.io/artifactory/helm-multicloud/cxcontact-022.03.121.tgz&#x22; https://pureengageuse1.jfrog.io/artifactory/helm-multicloud/cxcontact-022.03.121.tgz"]</code>.
 |Status=No
 }}{{Section

@@ Line 62: / Line 62: @@
 You can set up automated downloads for any repository using the '''Set Me Up''' screen for the corresponding repository.
 |Status=No
-}}
+}}{{Section
 |sectionHeading=Signing up for update notifications
 |anchor=sgnupdnot
@@ Line 78: / Line 76: @@
 {{NoteFormat|Update notifications are accumulated across 1-minute intervals and sent in a single email.|}}
 |Status=No
-}}
+}}{{Section
 |sectionHeading=Setting up automated downloads
 |anchor=setupautdown
@@ Line 119: / Line 115: @@
 For example,
-<code>curl -utest-use1edge:AP3joWh1WJkH39WbiGmvMUBCBD8 -O "[https://pureengageuse1.jfrog.io/artifactory/helm-premise/cxcontact-022.03.121.tgz&#x22; https://pureengageuse1.jfrog.io/artifactory/helm-premise/cxcontact-022.03.121.tgz"]</code>.
+<code>curl -u<username>:<apitoken> -O "[https://pureengageuse1.jfrog.io/artifactory/helm-premise/cxcontact-022.03.121.tgz&#x22; https://pureengageuse1.jfrog.io/artifactory/helm-premise/cxcontact-022.03.121.tgz"]</code>.
 |Status=No
 }}{{Section
@@ Line 141: / Line 137: @@
 }}
 }}

@@ Line 31: / Line 31: @@
 !Type of artifacts
 {{!}}-
-{{!}}helm-premise-local
+{{!}}helm-multicloud-local
 {{!}}Helm charts local repository
 {{!}}-
-{{!}}files-config-docker-premise-local
+{{!}}files-multicloud-local
 {{!}}Configuration files local repository
 {{!}}-
-{{!}}docker-premise-local
+{{!}}docker-multicloud-local
 {{!}}Docker local repository
 {{!}}-
-{{!}}helm-premise
+{{!}}helm-multicloud
 {{!}}Helm virtual repository
 {{!}}-
-{{!}}files-config-docker-premise
+{{!}}files-multicloud
 {{!}}Files virtual repository
 {{!}}-
-{{!}}docker-premise
+{{!}}docker-multicloud
 {{!}}Docker virtual repository
 {{!}}}

@@ Line 1: / Line 1: @@
 {{Article
 |Standalone=No
-|DisplayName=Downloading your Genesys Engage containers
+|DisplayName=Downloading your Genesys Multicloud CX containers
-|Context=Genesys Engage containers are accessible through JFrog. You can also automate downloads to set up a Continuous Delivery (CD) pipeline.
+|Context=Genesys Multicloud CX containers are accessible through JFrog. You can also automate downloads to set up a Continuous Delivery (CD) pipeline.
 |ComingSoon=No
 |Platform=Private Edition