updates to readme and contributing files

This commit is contained in:
John Peterson
2020-02-13 14:52:09 -08:00
parent e9ee970196
commit af2336cb37
3 changed files with 129 additions and 3 deletions

View File

@@ -1,7 +1,38 @@
# Openshift 4 Operators # 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.
## Artifactory HA Openshift OperatorHub has the latest official supported Cluster Service Version (CSV) for the OLM catalog.
## 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.
## Prerequisites
###### Openshift 4 Cluster
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.
[Code Ready Container Installer](https://cloud.redhat.com/openshift/install/crc/installer-provisioned)
###### Openshift 4 Command Line Tools
[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 Artifactory HA as an Openshift 4 operator please use the console's OperatorHub to install the official operator.
To install the operator locally please refer to the instructions that can be found in the README under artifactory-ha-operator. 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.
## 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

View File

@@ -0,0 +1,62 @@
# Contributing
When contributing to this repository, please first discuss the change you wish to make via slack, issue, email, or any other method with the owners of this repository before making a change.
Note we have a code of conduct, please follow it in all your interactions with the project.
## Pull Request Process
Ensure any install or build dependencies are removed before the end of the layer when doing a build.
Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
You may merge the Pull Request in once you have the sign-off of one other developer.
## Code of Conduct
### Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
### Our Standards
Examples of behavior that contributes to creating a positive environment include:
```
Using welcoming and inclusive language
Being respectful of differing viewpoints and experiences
Gracefully accepting constructive criticism
Focusing on what is best for the company
Showing empathy towards other colleagues
```
Examples of unacceptable behavior by participants include:
```
The use of sexualized language or imagery and unwelcome sexual attention or advances
Trolling, insulting/derogatory comments, and personal or political attacks
Public or private harassment
Publishing others' private information, such as a physical or electronic address, without explicit permission
Other conduct which could reasonably be considered inappropriate in a professional setting
```
### Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project. Examples of representing a project include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
Attribution
This Code of Conduct is adapted from the [Contributor Covenant version 1.4] (http://contributor-covenant.org/version/1/4)

View File

@@ -1,4 +1,28 @@
# Artifactory HA Operator # 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.
Openshift OperatorHub has the latest official supported Cluster Service Version (CSV) for the OLM catalog.
## 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.
## Prerequisites
###### Openshift 4 Cluster
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.
[Code Ready Container Installer](https://cloud.redhat.com/openshift/install/crc/installer-provisioned)
###### Openshift 4 Command Line Tools
[Getting Started with CLI](https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_cli/getting-started-cli.html)
## Cluster Setup ## Cluster Setup
###### Security Context Constraints - Anyuid ###### Security Context Constraints - Anyuid
@@ -58,6 +82,7 @@ You can then apply the example persistent volumes to your cluster with:
oc apply -f helm-charts/openshift-artifactory-ha/pv-examples oc apply -f helm-charts/openshift-artifactory-ha/pv-examples
``` ```
## Installation types ## Installation types
###### OLM Catalog ###### OLM Catalog
To install via the OLM catalog download the operator from the Operator hub and install it via the Openshift console GUI To install via the OLM catalog download the operator from the Operator hub and install it via the Openshift console GUI
@@ -127,3 +152,11 @@ Run:
cd JFrog-Cloud-Installers/Openshift4/artifactory-ha-operator cd JFrog-Cloud-Installers/Openshift4/artifactory-ha-operator
operator-sdk up local operator-sdk up local
``` ```
## 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.
## 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