diff --git a/Openshift4/README.md b/Openshift4/README.md index b68063b..08eaaad 100644 --- a/Openshift4/README.md +++ b/Openshift4/README.md @@ -1,5 +1,8 @@ -# Artifactory HA Operator -This code base is intended to deploy Artifactory HA as an operator to an Openshift4 cluster. You can run the operator either through the operator-sdk, operator.yaml, or the Operatorhub. +# JFrog Artifactory Enterprise Operator + +This code base is intended to deploy Artifactory Enterprise (HA) as an operator to an Openshift4 cluster. + +You can run the operator either through the operator-sdk, operator.yaml, or the OperatorHub OLM (CSV). Openshift OperatorHub has the latest official supported Cluster Service Version (CSV) for the OLM catalog. @@ -19,15 +22,23 @@ Or run it locally using CodeReadyContainers. [Code Ready Container Installer](https://cloud.redhat.com/openshift/install/crc/installer-provisioned) +Note if you are going to use CodeReadyContainers to test this Operator you will need to ensure: + +``` + - create at least one Persistent volume of 200Gi per Artifactory node used in HA configuration +``` + ###### Openshift 4 Command Line Tools +Download and install the Openshift command line tool: oc + [Getting Started with CLI](https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_cli/getting-started-cli.html) ## Next Steps -To install Artifactory HA as an Openshift 4 operator please use the console's OperatorHub to install the official operator. +To install JFrog Artifactory Enterprise as an Openshift 4 operator please use the console's OperatorHub to install the official operator. This is the easiest way to install it. -To install the operator locally please refer to the instructions that can be found in the README under artifactory-ha-operator. +If you wish to install the operator locally please refer to the instructions that can be found in the README under artifactory-ha-operator. ## Contributing Please read [CONTRIBUTING.md](JFrog-Cloud-Installers/Openshift4/artifactory-ha-operator/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. @@ -36,3 +47,5 @@ Please read [CONTRIBUTING.md](JFrog-Cloud-Installers/Openshift4/artifactory-ha-o We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/jfrog/JFrog-Cloud-Installers/tags). ## Contact + +Github issues \ No newline at end of file diff --git a/Openshift4/artifactory-ha-operator/README.md b/Openshift4/artifactory-ha-operator/README.md index 7b25a3b..9a96d75 100644 --- a/Openshift4/artifactory-ha-operator/README.md +++ b/Openshift4/artifactory-ha-operator/README.md @@ -1,4 +1,5 @@ -# Artifactory HA Operator +# JFrog Artifactory Enterprise Operator + This code base is intended to deploy Artifactory HA as an operator to an Openshift4 cluster. You can run the operator either through the operator-sdk, operator.yaml, or the Operatorhub. Openshift OperatorHub has the latest official supported Cluster Service Version (CSV) for the OLM catalog. @@ -19,8 +20,16 @@ Or run it locally using CodeReadyContainers. [Code Ready Container Installer](https://cloud.redhat.com/openshift/install/crc/installer-provisioned) +Note if you are going to use CodeReadyContainers to test this Operator you will need to ensure: + +``` + - create at least one Persistent volume of 200Gi per Artifactory node used in HA configuration +``` + ###### Openshift 4 Command Line Tools +Download and install the Openshift command line tool: oc + [Getting Started with CLI](https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_cli/getting-started-cli.html) ## Cluster Setup @@ -36,53 +45,24 @@ oc adm policy add-scc-to-user anyuid system:serviceaccount:jfrog-artifactory:art Where anyuid is the Security context constraint being applied to the service account artifactory-ha-operator in namespace jfrog-artifactory. -If you run setup.sh these will be created on the cluster your kubectl or oc program is connected to. +In addition to this the restricted scc policy will need to be changed to allow anyuid: -###### Security Context Constraints - Hostpath - -Openshift does not have the hostpath plugin enabled by default. - -A security context constraint has been created for hostpath in deploy/hostpathscc.yaml - -You can apply the security context constraint and hostpath plugin patch via these commands: - -``` -oc apply -f deploy/hostpathscc.yaml -oc patch securitycontextconstraints.security.openshift.io/hostpath --type=merge --patch='{"allowHostDirVolumePlugin": true}' -oc adm policy add-scc-to-user hostpath system:serviceaccount:jfrog-artifactory:artifactory-ha-operator +``` +oc patch scc restricted --patch '{"fsGroup":{"type":"RunAsAny"},"runAsUser":{"type":"RunAsAny"},"seLinuxContext":{"type":"RunAsAny"}}' --type=merge ``` -Or if you run setup.sh these will already be done. +The privileged scc policy will need to be changed to include the artifactory-ha-operator as an admin account: -###### Persistent Volumes +``` +oc patch scc privileged --patch '{"users":["system:admin","system:serviceaccount:openshift-infra:build-controller","system:serviceaccount:jfrog-artifactory:artifactory-ha-operator"]}' --type=merge +``` + +###### Persistent Volumes on Code Ready Containers Artifactory HA nodes by default request persistent volume claims 200 Gbs in size. If your cluster does not already have existing persistent volumes that are 200Gi you will need to create new persistent volumes that are large enough to bound the claims to. -Example persistent volumes can be found at: - -``` -helm-charts/openshift-artifactory-ha/pv-examples -``` - -If you create the five folders on each node: - -``` -mkdir -p /mnt/pv-data/pv0001-large -mkdir -p /mnt/pv-data/pv0002-large -mkdir -p /mnt/pv-data/pv0003-large -mkdir -p /mnt/pv-data/pv0004-large -mkdir -p /mnt/pv-data/pv0005-large -``` - -You can then apply the example persistent volumes to your cluster with: - -``` -oc apply -f helm-charts/openshift-artifactory-ha/pv-examples -``` - - ## Installation types ###### OLM Catalog To install via the OLM catalog download the operator from the Operator hub and install it via the Openshift console GUI @@ -160,3 +140,5 @@ Please read [CONTRIBUTING.md](JFrog-Cloud-Installers/Openshift4/artifactory-ha-o We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/jfrog/JFrog-Cloud-Installers/tags). ## Contact + +Github Issues \ No newline at end of file