Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[openshift] JFrog highly recommends using JFrog Helm Charts for deployments on OpenShift clusters #405

Merged
merged 3 commits into from
Aug 6, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 17 additions & 14 deletions Openshift4/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# JFrog Unified Platform On Openshift

JFrog Unified Platform on Openshift official support is for the operator deployment only through Openshift's Operatorhub.
## Announcement (August 2024)
JFrog Platform on Openshift official support was added to the JFrog Helm Charts.
JFrog highly recommends using JFrog Helm Charts for deployments on OpenShift clusters.

Openshift OperatorHub will contain the latest official supported version. We strive to always release every minor version to Openshift's Operatorhub.
For more information, see [Install Artifactory HA](https://jfrog.com/help/r/jfrog-installation-setup-documentation/install-artifactory-ha-on-openshift) and [Install Xray HA](https://jfrog.com/help/r/jfrog-installation-setup-documentation/xray-ha-openshift-installation).

## Repo Layout
## JFrog Openshift Operators
The JFrog Openshift Operators are maintained alternative methods of deploying JFrog productsfor OpenShift platforms based on the JFrog Helm Charts.

### Repo Layout

| Folder | Purpose |
|---------------------------------|---------------------------------------------------------|
Expand All @@ -17,15 +22,13 @@ Openshift OperatorHub will contain the latest official supported version. We str
| operator/xray-operator | Xray Enterprise Operator |
| operator/pipeline-operator | Pipelines Operator (Beta) |

## How to install?
### How to install?

You can find the Redhat certified Operators in the Operatorhub in your Openshift web console.

You will need to be an administrator of your Openshift cluster to install our operator.

Additional steps can be found at [JFrog Partner support wiki](https://www.jfrog.com/confluence/display/JFROG/JFrog+Partner+Integrations#JFrogPartnerIntegrations-redhatopenshift]).

## Security Context Constraints
### Security Context Constraints

The `restricted` security context constraint will prevent the helm or operator from deploying into Openshift on most namespaces.

Expand All @@ -37,15 +40,15 @@ Below is an example of applying the `anyuid` scc to the service account `openshi

Once the `anyuid` scc has been applied to the correct service accounts the helm charts or operators will deploy into your Openshift cluster.

## Custom User or Group Ids
### Custom User or Group Ids

The images uploaded to `registry.redhat.connect.com` that the helm charts and operators use have been modified from the standard docker images available at `docker.bintray.io`

These images have been customized to run in the Openshift user id and group id range of `1000720000/10000`

If you need to use another custom user id and/or group id range you can change the `uid` and `gid` values in `values.yaml` of the relevant helm chart or operator yaml deployment.

## No Root Environments
### No Root Environments

Some environments do not allow root. In these scenarios users can remove the `customInitContainersBegin` from the example values.yaml below:

Expand All @@ -68,20 +71,20 @@ Some environments do not allow root. In these scenarios users can remove the `cu

Once this has been removed there is no other root user permissions are required to deploy into Openshift.

## Why are there different helm charts?
### Why are there different helm charts?

The charts in the helm folder are used specifically to create the helm based operator for the certification process to enable it into the Openshift Operatorhub as a certified operator.

The `values.yaml` contained in those relevant charts have been modified to work in Redhat Openshift. The base chart however has not been changed only made a sub-chart.

Helm users can reference the `values.yaml` to modify their own deployments to work with Openshift.

## Contributing
### Contributing
Please read [CONTRIBUTING.md](JFrog-Cloud-Installers/Openshift4/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning
### Versioning
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
### Contact

Github issues are the preferred way to communicate with the team. The team is notified via Slack when a new issue is created.
Github issues are the preferred way to communicate with the team. The team is notified via Slack when a new issue is created.
Loading