ansible-collection-openshift

KO | EN

gitlite — search

#javascript #ai #typescript #rust #deep-learning #java #nodejs #windows #awesome #cli #kubernetes #awesome-list #vue #mcp

ansible-collection-openshift

(★ 12)

A collection that bundles roles for the management of OpenShift clusters

ansible-collection-openshift Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ansible-collection-openshift

A collection that bundles roles for the management of OpenShift clusters

## Roles

- **add_nodes**: A role to add nodes to an OpenShift cluster
- **bootstrap_cluster**: A role to bootstrap an OpenShift cluster
- **cluster_installation_check**: A role to check the installation status of an OpenShift cluster
- **configure_olm**: A role to configure the operator hub and add custom CatalogSources on a OpenShift cluster
- **bootstrap_gitops**: A role to install and configure OpenShift GitOps on an OpenShift cluster
- **configure_nodes**: A role to label and/or taint nodes in an OpenShift cluster
- **mirror_images**: A role to mirror OpenShift Operators and container images to a private registry

## Execution Environment

This collection includes an Ansible Execution Environment (EE) that packages the collection with all its dependencies and OpenShift CLI tools for easy deployment and usage.

### Container Images

The execution environment images are automatically built and published to:

**Quay.io Container Registry**: <https://quay.io/redhat-consulting-services/ee-openshift>

> ⚠️ **Attention**
>
> Starting with release `v1.0.0`, we have switched from GitHub Container Registry (GHCR) to Quay.io for hosting our execution environment images.
>
> The GHCR registry will no longer receive updates, and all new images will be published to Quay.io.

### Automatic Builds

When a new release is created, we automatically build both the collection and execution environment container images. These builds are based on the OpenShift versions specified in the `.github/openshift-versions.json` file.

Once the builds are complete, the execution environment container images are tagged and pushed to the Quay.io Container Registry. The image tags follow the format:

```txt
<release-version>-ocp-<openshift-version>-<build-timestamp>
```

Assuming a release version of `v1.0.0`, OpenShift version `4.19.15`, and a build timestamp of `202407221430`, the resulting image tag would be:

```txt
v1.0.0-ocp-4.19.15-202407221430
```

Right now, we build images for the last five minor OpenShift versions, each with the last five patch versions. For the list of supported OpenShift versions, refer to the `.github/openshift-versions.json` file.

When a new release is created, we also create `latest` tags for the most recent patch version of each minor OpenShift version. Continuing the previous example, if `4.21.5` is the latest patch version for the `4.21` minor version, the following `latest` tag would also be created:

```txt
v1.0.0-ocp-4.21.5-latest
```

### Adding New OpenShift Versions

OpenShift versions are managed via the `scripts/versions-extract.py` script, which extracts the latest versions from `mirror.openshift.com` and updates the `.github/openshift-versions.json` file. The GitHub Actions workflow `.github/workflows/update-version-matrix.yaml` runs this script to keep the version matrix up to date (currently once a week). Manual updates to the JSON are not recommended, as they will be overwritten by the script.

### What's Included

Each execution environment includes:

- **Ansible Collection**: `redhat_consulting_services.openshift`
- **OpenShift CLI Tools**:
  - `oc` - OpenShift command-line interface
  - `openshift-install` - Cluster installation tool
  - `oc-mirror` - Registry mirroring tool
- **Python Dependencies**: All required Python packages
- **Ansible Collections**: `community.general`, `kubernetes.core`

### Manual Build

To build the execution environment locally:

```bash
ansible-builder build --context . -t my-ee:latest --build-arg OPENSHIFT_VERSION=4.19.15
```

### Usage

Instructions on how to use the execution environment and the collection can be found in the [examples/dell_hardware](./examples/dell_hardware/README.md) directory.

## CI Flow

```mermaid
flowchart LR
    A[Commit]
    B[Push to branch]

C[CI: Linting and Testing]
    C1{Linting and Testing successful?}

D[Build Ansible collection]
    D1{Collection Build successful?}
    D2{Has been tagged and is main branch?}
    D3[Push to Galaxy]

E[Merge to main branch]

F[Run Execution Environment Build]
    F1{Execution Environment Build successful?}
    F2[Push to quay.io/redhat-consulting-services/ee-openshift]

G[Inform developers]

A --> B --> C --> C1
    C1 -- Yes --> D --> D1
    D1 -- Yes --> D2
    D1 -- No --> A

C1 -- No --> A

D2 -- Yes --> D3
    D2 -- No --> E --> B

D3 --> F --> F1
    F1 -- Yes --> F2
    F1 -- No --> G
```

ansible-collection-openshift

ansible-collection-openshift Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ansible-collection-openshift

ansible-collection-openshift Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README