Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.82 KB

CONTRIBUTING.adoc

File metadata and controls

60 lines (41 loc) · 2.82 KB
Raw

Development Environment

  1. $ git clone https://github.com/ploigos/ploigos-software-factory-operator.git

  2. install docker, podman will not work with the molecule tests right now

  3. install make

  4. install python3

  5. pip3 install docker==4.2.2 molecule ansible-lint yamllint flake8 openshift jmespath

  6. ansible-galaxy collection install -r requirements.yml

Fedora 32

  1. sudo grubby --update-kernel=ALL --args="systemd.unified_cgroup_hierarchy=0"`

  2. sudo dnf remove podman-docker ← if this is installed on your machine

  3. sudo dnf install moby-engine

  4. sudo systemctl enable docker.service --now

  5. sorry now you need to reboot

Development Workflow

  1. $ oc login ← as cluster admin

  2. $ hack/operate.sh ← install the operator. It will be deployed into the ploigos-operator-system namespace by default.

  3. Create a CR for whatever you’re testing. You can check the config/samples directory. For example: oc apply -f config/samples/redhatgov_v1alpha1_ploigosplatform_jenkins.yaml -n ploigos-operator-system. This will provision a PloigosPlatform in the ploigos-operator-system namespace.

  4. If you make some Ansible changes and need to test them, you need to rebuild the operator image.

    1. Carefully cleanup the ploigos-operator-system project (so as not to orphan resources and leave the project stuck in Terminating) by deleting the PloigosPlatform (e.g. oc delete ploigosplatform --all), and then removing the operator installation by running hack/operate.sh -r

    2. Override the default operator image in a shell variable: OPERATOR_IMAGE=quay.io/<your quay username>/ploigos-operator

    3. Build and push the image (requires a container runtime on your local): ./hack/operate.sh --image=$OPERATOR_IMAGE --version=latest --push-only. If this is the first time you’re doing this, you’ll need to login to quay.io and change your repo from Private to Public so OCP can pull it

    4. Deploy the operator from your new image: hack/operate.sh --image=$OPERATOR_IMAGE --version=latest

    5. Recreate the CR: oc apply -f config/samples/redhatgov_v1alpha1_ploigosplatform_jenkins.yaml -n ploigos-operator-system

Testing

In the example below are all the env vars that you need to set in your terminal. Note that you need to replace all the 'replace’s, one in each env var.

export OCP_SERVER=replace
export OCP_USERNAME=replace
export OCP_PASSWORD='replace'
export QUAY_USERNAME=replace
export QUAY_PASSWORD='replace'
export OPERATOR_IMAGE=quay.io/replace/ploigos-operator

Make sure the repo provided is public for the env var OPERATOR_IMAGE

Now you can execute the molecule tests repeatedly as much as you like with this command:

molecule test -s ocp-cluster

PR Testing

describe current TravisCI integration

Process for Publishing a Release of the Operator