operator-controller

(★ 212)

A new and improved management framework for extending Kubernetes with Operators

File Explorer

Download Latest Version (.zip)

- .gitignore
- bingo.mod
- bingo.sum
- conftest.mod
- conftest.sum
- controller-gen.mod
- controller-gen.sum
- crd-diff.mod
- crd-diff.sum
- crd-ref-docs.mod
- crd-ref-docs.sum
- go.mod
- golangci-lint.mod
- golangci-lint.sum
- goreleaser.mod
- goreleaser.sum
- helm.mod
- helm.sum
- kind.mod
- kind.sum
- kube-score.mod
- kube-score.sum
- mockgen.mod
- mockgen.sum
- operator-sdk.mod
- operator-sdk.sum
- opm.mod
- opm.sum
- OWNERS
- README.md
- setup-envtest.mod
- setup-envtest.sum
- variables.env
- Variables.mk
- yamlfmt.mod
- yamlfmt.sum
- - olm-dev-environment-specialist.md
- - api-lint-diff.md
  - list-e2e-steps.md
  - test-profile.md
- - config.yml
  - docs-issue.yml
- - add-to-project.yaml
  - api-diff-lint.yaml
  - crd-diff.yaml
  - e2e.yaml
  - files-diff.yaml
  - go-apidiff.yaml
  - go-verdiff.yaml
  - pages.yaml
  - pr-title.yaml
  - release.yaml
  - sanity.yaml
  - stale.yml
  - test-regression.yaml
  - tilt.yaml
  - unit-test.yaml
  - update-demos.yaml
- dependabot.yml
- OWNERS
- pull_request_template.md
- - clustercatalog_types.go
  - clustercatalog_types_test.go
  - clusterextension_types.go
  - clusterextension_types_test.go
  - clusterobjectset_types.go
  - clusterobjectset_types_test.go
  - common_types.go
  - groupversion_info.go
  - suite_test.go
  - validation_test.go
  - zz_generated.deepcopy.go
- OWNERS
- - internal.go
- utils.go
- - main.go
- - main.go
- OWNERS
- - catalogd_operatorcatalog.yaml
  - kustomization.yaml
  - olm_v1_clusterextension.yaml
- OWNERS
- README.md
- - kind-with-registry-podman.sh
  - setup-local-env-podman.md
- local-debugging-with-tilt-and-vscode.md
- - catalogd-webserver.md
  - crd-ref-docs-gen-config.yaml
  - olmv1-api-reference.md
- - logo.svg
- - controlling-catalog-selection.md
  - crd-upgrade-safety.md
  - single-owner-objects.md
  - upgrade-support.md
  - version-ranges.md
- - contributing.md
  - developer.md
- - extra.css
- - OWNERS
- - olmv1_getting_started.md
- - catalog-queries.md
  - how-to-channel-based-upgrades.md
  - how-to-grant-api-access.md
  - how-to-pin-version.md
  - how-to-protect-olmv1-api-access.md
  - how-to-version-range-upgrades.md
  - how-to-z-stream-upgrades.md
- - olmv1_architecture.md
  - olmv1_community.md
  - olmv1_design_decisions.md
  - olmv1_limitations.md
  - olmv1_roadmap.md
  - public-api.md
- - add-catalog.md
  - downgrade-extension.md
  - explore-available-content.md
  - install-extension.md
  - uninstall-extension.md
  - upgrade-extension.md
- .gitignore
- index.md
- OWNERS
- - run.sh
- - e2e-coverage.sh
- - .gitkeep
  - check-go-version.sh
  - update-crds.sh
  - update-kind-images.sh
  - update-registryv1-bundle-schema.sh
  - update-tls-profiles.sh
  - validate_kindest_node.sh
- boilerplate.go.txt
- OWNERS
- - .helmignore
  - Chart.yaml
  - values.yaml
- cert-manager.yaml
- e2e.yaml
- experimental.yaml
- OWNERS
- tilt.yaml
- - OWNERS
- kind-config-2node.yaml
- kind-config.yaml
- default-catalogs.yaml
- experimental-e2e.yaml
- experimental.yaml
- OWNERS
- standard-e2e.yaml
- standard.yaml
- install.tpl.sh
- OWNERS
- - features_test.go
  - README.md
  - support-bundle.yaml
- - extension_developer_test.go
  - setup.sh
- - README.md
  - upgrade_test.go
- utils.go
- - values.yaml
- - values-experimental.yaml
  - values.yaml
- .gitignore
.dockerignore
.gitignore
.golangci.yaml
.goreleaser.yml
.tilt-support
.tiltignore
AGENTS.md
codecov.yml
CONTRIBUTING.md
crd-diff-config.yaml
DCO
Dockerfile.catalogd
Dockerfile.operator-controller
go.mod
go.sum
LICENSE
Makefile
Makefile.venv
mkdocs.yml
netlify.toml
OWNERS
OWNERS_ALIASES
PROJECT
README.md
RELEASE.md
requirements.txt
runtime.txt
Tiltfile

# Installation Guide

1. Get the code

git clone https://github.com/operator-framework/operator-controller

Downloads the entire project code from GitHub to your computer.

cd operator-controller

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -f Dockerfile.catalogd -t operator-controller .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 operator-controller

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

4. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

cd .bingo

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

5. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)