updates to readmes and including base chart readme w/ openshift intro also contributing file

This commit is contained in:
John Peterson
2020-05-22 12:55:48 -07:00
parent 127ed35f4a
commit 704ec06158
4 changed files with 2056 additions and 10 deletions

View File

@@ -1,14 +1,12 @@
# JFrog Artifactory Enterprise Operator
# JFrog Unified Platform On Openshift
This code base is intended to deploy Artifactory Enterprise (HA) as an operator to an Openshift4 cluster.
This code base is intended to deploy JFrog Unified Platform products as either helm or 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.
Openshift OperatorHub has the latest official supported version to deploy via the GUI.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Optionally you can deploy into Openshift4 as helm.
## Prerequisites
@@ -18,14 +16,15 @@ Available on AWS, GCP, or Azure. Follow the Cloud installer guide available here
[Openshift 4 Installers](https://cloud.redhat.com/openshift/install)
Or run it locally using CodeReadyContainers.
Or run it locally using CodeReadyContainers or your own on-perm solution.
[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:
Note if you are going to use CRC / On-prem to run the Operators you will need to ensure:
```
- create at least one Persistent volume of 200Gi per Artifactory node used in HA configuration
- create at least 3 or more additional Persistent volumes 100Gi in size or more for Postgresql, Rabbitmq, and other components used.
```
###### Openshift 4 Command Line Tools
@@ -36,9 +35,31 @@ Download and install the Openshift command line tool: oc
## Next Steps
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 JFrog Operators please use the web console's OperatorHub to install the official operators. This is the easiest way to install it.
If you wish 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(s) locally please refer to the instructions that can be found in the README under artifactory-ha-operator.
## Helm Deployments
The necessary helm fixes for it to work in Openshift have been patched for each product in the following subfolders:
Artifactory HA Helm Chart:
```
openshift-artifactory-ha
```
Xray Helm Chart:
```
openshift-xray
```
However to use helm you will need to apply RunAsAny shown below:
```
oc patch scc restricted --patch '{"fsGroup":{"type":"RunAsAny"},"runAsUser":{"type":"RunAsAny"},"seLinuxContext":{"type":"RunAsAny"}}' --type=merge
```
Once your cluster has been patched you can then deploy via helm using the openshift charts shown above.
## 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.