airship/armada-operator
Code Issues Proposed changes
A Kubernetes operator for declarative managing Helm chart releases with Armada charts as Kubernetes manifests.
4 Commits 1 Branch 0 Tags 244 KiB
Go 82.9%
Makefile 12.9%
Python 4.2%
d557f99c8f
Go to file
Ruslan Aliev d557f99c8f Rename internal to pkg to make inner pkgs importable 
Other small fixes and improvements included.

Change-Id: I878c4dce66e62e9128cbec658fc98e1ef71e8047
Signed-off-by: Ruslan Aliev <raliev@mirantis.com>
2024-02-07 10:53:52 -06:00
api/v1 Initial commit 2024-01-31 17:47:36 -06:00
cmd Rename internal to pkg to make inner pkgs importable 2024-02-07 10:53:52 -06:00
config Initial commit 2024-01-31 17:47:36 -06:00
hack Initial commit 2024-01-31 17:47:36 -06:00
images/armada-operator Rename internal to pkg to make inner pkgs importable 2024-02-07 10:53:52 -06:00
pkg Rename internal to pkg to make inner pkgs importable 2024-02-07 10:53:52 -06:00
tools Initial commit 2024-01-31 17:47:36 -06:00
.dockerignore Initial commit 2024-01-31 17:47:36 -06:00
.gitignore Initial commit 2024-01-31 17:47:36 -06:00
.gitreview Added .gitreview 2024-01-04 20:22:34 +00:00
.zuul.yaml Fix naming of zuul nodeset 2024-02-05 17:09:55 -06:00
go.mod Initial commit 2024-01-31 17:47:36 -06:00
go.sum Initial commit 2024-01-31 17:47:36 -06:00
Makefile Initial commit 2024-01-31 17:47:36 -06:00
PROJECT Initial commit 2024-01-31 17:47:36 -06:00
README.md Initial commit 2024-01-31 17:47:36 -06:00

README.md

armada-operator

Description

// TODO(user): An in-depth paragraph about your project and overview of use

Getting Started

You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

Running on the cluster

  1. Install Instances of Custom Resources:
kubectl apply -k config/samples/
  1. Build and push your image to the location specified by IMG:
make docker-build docker-push IMG=<some-registry>/armada-operator:tag
  1. Deploy the controller to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/armada-operator:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller from the cluster:

make undeploy

Contributing

// TODO(user): Add detailed information on how you would like others to contribute to this project

How it works

This project aims to follow the Kubernetes Operator pattern.

It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.

Test It Out

  1. Install the CRDs into the cluster:
make install
  1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make run

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2023.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.