Imported from openstack-k8s-operators/install_yamls (AGENTS.md). Install upstream with npx skills add openstack-k8s-operators/install_yamls. Copyright stays with the author.

AGENTS.md

What is this repository

install_yamls is a k8s YAML generator and installer for Cloud Native OpenStack (RHOSO -- Red Hat OpenStack Services on OpenShift). It automates deploying OpenStack operators and services on a pre-installed OpenShift cluster.

The upstream repository lives at https://github.com/openstack-k8s-operators/install_yamls.

Tech stack

• GNU Make as the primary user interface (two Makefiles).
• Bash scripts for YAML generation (kustomize), operator lifecycle, and environment setup.
• Ansible playbooks and roles under devsetup/ for tool download and NFS provisioning.
• kustomize for CR/resource generation (output to out/).
• Zuul for CI (end-to-end jobs, no unit test suite).

Two-layer architecture

The repository has an intentional two-layer split. Agents must respect this boundary.

Repository layout

Critical rules

No host mutation from root Makefile

The root Makefile and scripts/ must never require sudo or change the local machine beyond what oc/kubectl do. If a new feature needs host-level changes, it belongs in devsetup/.

Output directory

Generated YAML goes to ${OUT} (defaults to ./out/). This directory is gitignored. Never commit its contents.

Variable overrides

All Makefile variables use ?= (conditional assignment). Override via environment or command-line:

NETWORK_ISOLATION=false make openstack_deploy

Do not commit secrets

The following are gitignored and must never be committed: pull-secret.txt, kubeconfig, ansibleee-ssh-key-id_rsa*, tls.crt.

Script naming conventions

OKD support

Pass OKD=true to any root Makefile target to deploy on OKD community distro instead of OCP.

Key Makefile targets (root)

Key Makefile targets (devsetup)

Operator and architecture data flow

make *_repo targets (for example make openstack_repo) clone individual operator repositories into ${OPERATOR_BASE_DIR} (defaults to ./out/operator/). That checkout supplies sample CRs and kustomize bases used by the root Makefile.

openstack_deploy_prep generates the OpenStackControlPlane CR from sample files in the cloned openstack-operator repo, applying network isolation, bridge config, and other Makefile variables.

The architecture repository provides validated architecture patterns (DT/VA configs). openstack_deploy can apply these as sample CR YAML; choose the sample with the OPENSTACK variable (path to the sample file).

Typical deployment workflow

Prerequisites before Phase 1

• Pull secret: pull-secret.txt in devsetup/ (from https://cloud.redhat.com/openshift/create/local) or override with the PULL_SECRET environment variable.

See devsetup/README.md for setup details.

Phase 1: Environment setup (devsetup/)

cd devsetup
make crc                           # Install CRC
make download_tools                # Install oc, kubectl, kustomize, etc.
make crc_attach_default_interface  # Attach network for isolation
EDPM_TOTAL_NODES=2 make edpm_compute  # Create compute VMs
cd ..

Prerequisites before Phase 2

Before running Makefile targets against the cluster:

• Host tools: kubectl/oc and kustomize (install via make download_tools in devsetup/).
• Cluster access: Logged in with oc login or KUBECONFIG pointing at a valid kubeconfig.

Phase 2: OpenStack deployment (root)

make crc_storage      # Initialize PVs
make input            # Create secrets/configmaps
make openstack        # Install openstack-operator via OLM
make openstack_init   # Deploy sub-operators (runs openstack_prep if needed)
make openstack_deploy # Deploy OpenStackControlPlane CR
DATAPLANE_TOTAL_NODES=2 make edpm_wait_deploy # Deploy and wait for data plane readiness

Testing and linting

No unit test suite

Validation is done exclusively via Zuul end-to-end jobs. There is no local test framework to run.

Pre-commit hooks

Run locally with:

pre-commit run --all-files

The following hooks are configured:

• yamllint -- strict mode, max line length 150 characters.
• ansible-lint -- v6.12.2, skips no-handler rule.
• bashate -- ignores E006, E040, E043, E003.
• Standard file checks (trailing whitespace, merge conflicts, BOM, shebangs).

Zuul CI jobs

Jobs defined in zuul.d/:

• openstack-k8s-operators-content-provider -- builds operator images.
• install-yamls-crc-podified-edpm-baremetal -- baremetal EDPM E2E.
• podified-multinode-edpm-deployment-crc -- multi-node EDPM E2E.
• adoption-standalone-to-crc-*-provider -- adoption flow tests.

Files irrelevant to CI (will not trigger jobs): .ansible-lint, .gitignore, .yamllint, .pre-commit-config.yaml, LICENSE, OWNERS, */*.md.

Relationship to other repos

Commit conventions

• Review governed by OWNERS file (Prow/K8s style).
• Minimum 2 approvals from listed approvers required.
• Default branch: main. PRs on GitHub target main.
• Keep commit messages descriptive; no strict prefix convention.

Confirm before acting

Agents should confirm with the user before:

• Modifying the root Makefile -- blast radius covers all deployment flows.
• Adding sudo-requiring commands to root-level scripts -- violates the no-host-mutation contract.
• Changing default variable values (?= assignments) -- affects all downstream consumers including CI.
• Modifying zuul.d/ -- affects CI for all PRs to this repo.

Documentation first

Before searching the web, check:

• README.md -- project overview and deployment examples.
• devsetup/README.md -- CRC, EDPM, BMaaS, and IPv6 LAB setup guides.
• make help -- lists all available targets with descriptions.