├── .github ├── dependabot.yaml └── workflows │ └── test.yaml ├── kubernetes ├── clusters │ └── local │ │ ├── registry.yaml │ │ ├── instance.yaml │ │ ├── infra.yaml │ │ └── apps.yaml ├── infra │ ├── gateway-api.yaml │ ├── cert-manager.yaml │ └── metrics-server.yaml └── apps │ ├── redis.yaml │ └── podinfo.yaml ├── scripts ├── kind-down.sh ├── flux-sync.sh ├── flux-up.sh ├── flux-push.sh └── kind-up.sh ├── Brewfile ├── .gitignore ├── Makefile ├── README.md ├── CLAUDE.md └── LICENSE /.github/dependabot.yaml: -------------------------------------------------------------------------------- 1 | version: 2 2 | 3 | updates: 4 | - package-ecosystem: "github-actions" 5 | directory: "/" 6 | groups: 7 | actions: 8 | patterns: 9 | - "*" 10 | schedule: 11 | interval: "weekly" 12 | -------------------------------------------------------------------------------- /kubernetes/clusters/local/registry.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: fluxcd.controlplane.io/v1 2 | kind: ResourceSetInputProvider 3 | metadata: 4 | name: registry 5 | namespace: flux-system 6 | spec: 7 | type: Static 8 | defaultValues: 9 | repository: "flux-registry:5000" 10 | tag: "local" 11 | insecure: true 12 | -------------------------------------------------------------------------------- /scripts/kind-down.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # Copyright 2024 Stefan Prodan 4 | # SPDX-License-Identifier: AGPL-3.0 5 | 6 | set -o errexit 7 | 8 | cluster_name="${CLUSTER_NAME:=flux}" 9 | reg_name="${cluster_name}-registry" 10 | 11 | kind delete cluster --name ${cluster_name} 12 | 13 | docker rm -f ${reg_name} 14 | -------------------------------------------------------------------------------- /Brewfile: -------------------------------------------------------------------------------- 1 | # Kubernetes 2 | brew "kubectl" 3 | brew "kind" 4 | 5 | # Kubernetes tools 6 | brew "helm" 7 | brew "kustomize" 8 | brew "kubeconform" 9 | 10 | # Flux 11 | tap "fluxcd/tap" 12 | brew "fluxcd/tap/flux" 13 | 14 | # Flux Operator 15 | tap "controlplaneio-fluxcd/tap" 16 | brew "controlplaneio-fluxcd/tap/flux-operator" 17 | -------------------------------------------------------------------------------- /scripts/flux-sync.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # Copyright 2024 Stefan Prodan 4 | # SPDX-License-Identifier: AGPL-3.0 5 | 6 | set -o errexit 7 | 8 | echo "Waiting for cluster addons sync to complete" 9 | flux reconcile kustomization infra-sync --with-source 10 | 11 | echo "Waiting for apps sync to complete" 12 | flux reconcile kustomization apps-sync --with-source 13 | flux tree kustomization apps-sync 14 | 15 | echo "✔ Cluster is in sync" 16 | -------------------------------------------------------------------------------- /scripts/flux-up.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # Copyright 2025 Stefan Prodan 4 | # SPDX-License-Identifier: AGPL-3.0 5 | 6 | set -o errexit 7 | 8 | echo "Starting cluster bootstrap" 9 | flux-operator install -f ./kubernetes/clusters/local/instance.yaml 10 | 11 | echo "" 12 | echo "Waiting for cluster addons sync to complete" 13 | flux-operator -n flux-system wait rset infra --timeout=5m 14 | flux tree kustomization infra-sync 15 | 16 | echo "Waiting for apps sync to complete" 17 | flux-operator -n flux-system wait rset apps --timeout=5m 18 | flux tree kustomization apps-sync 19 | 20 | echo "✔ Cluster is ready" 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # If you prefer the allow list template instead of the deny list, see community template: 2 | # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore 3 | # 4 | # Binaries for programs and plugins 5 | *.exe 6 | *.exe~ 7 | *.dll 8 | *.so 9 | *.dylib 10 | 11 | # Test binary, built with `go test -c` 12 | *.test 13 | 14 | # Output of the go coverage tool, specifically when used with LiteIDE 15 | *.out 16 | 17 | # Dependency directories (remove the comment below to include it) 18 | # vendor/ 19 | 20 | # Go workspace file 21 | go.work 22 | go.work.sum 23 | 24 | # env file 25 | .env 26 | 27 | # tools 28 | bin/ 29 | Brewfile.lock.json 30 | 31 | -------------------------------------------------------------------------------- /.github/workflows/test.yaml: -------------------------------------------------------------------------------- 1 | name: test 2 | 3 | on: 4 | pull_request: 5 | push: 6 | branches: 7 | - 'main' 8 | 9 | permissions: 10 | contents: read 11 | 12 | jobs: 13 | e2e: 14 | runs-on: ubuntu-latest 15 | steps: 16 | - name: Checkout 17 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 18 | - name: Setup Flux CLI 19 | uses: fluxcd/flux2/action@8454b02a32e48d775b9f563cb51fdcb1787b5b93 #v2.7.5 20 | - name: Setup Flux Operator CLI 21 | uses: controlplaneio-fluxcd/flux-operator/actions/setup@fe04687bb75f0fcc71c8ba2f601af4e8ffcb02fe #v0.36.0 22 | - run: make up 23 | - run: make sync 24 | - run: make ls 25 | - run: make down 26 | -------------------------------------------------------------------------------- /kubernetes/clusters/local/instance.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: fluxcd.controlplane.io/v1 2 | kind: FluxInstance 3 | metadata: 4 | name: flux 5 | namespace: flux-system 6 | spec: 7 | distribution: 8 | version: "2.x" 9 | registry: "ghcr.io/fluxcd" 10 | artifact: "oci://ghcr.io/controlplaneio-fluxcd/flux-operator-manifests:latest" 11 | components: 12 | - source-controller 13 | - kustomize-controller 14 | - helm-controller 15 | - notification-controller 16 | - source-watcher 17 | cluster: 18 | type: kubernetes 19 | size: medium 20 | multitenant: false 21 | networkPolicy: true 22 | domain: "cluster.local" 23 | sync: 24 | kind: OCIRepository 25 | url: "oci://flux-registry:5000/flux-cluster-sync" 26 | ref: "local" 27 | path: "./" 28 | kustomize: 29 | patches: 30 | - patch: | 31 | - op: add 32 | path: /spec/insecure 33 | value: true 34 | target: 35 | kind: OCIRepository 36 | -------------------------------------------------------------------------------- /scripts/flux-push.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # Copyright 2025 Stefan Prodan 4 | # SPDX-License-Identifier: AGPL-3.0 5 | 6 | set -o errexit 7 | 8 | kubernetes_path='kubernetes' 9 | cluster_name='local' 10 | registry='localhost:5050' 11 | 12 | diff_push() { 13 | artifact_name=$1 14 | artifact_path=$2 15 | diff_exit_code=0 16 | push_exit_code=0 17 | 18 | flux diff artifact oci://${artifact_name} \ 19 | --path="${artifact_path}" &>/dev/null || diff_exit_code=$? 20 | 21 | if [[ ${diff_exit_code} -ne 0 ]]; then 22 | flux_output=$(flux push artifact oci://${artifact_name} \ 23 | --path="${artifact_path}" \ 24 | --source="$(git config --get remote.origin.url)" \ 25 | --revision="$(git rev-parse HEAD)" 2>&1) || push_exit_code=$? 26 | 27 | oci_url=$(echo ${flux_output} | tail -n1 | awk '/to/{print $NF}') 28 | else 29 | echo "✔ no changes detected in ${artifact_path}" 30 | return 31 | fi 32 | 33 | if [[ ${push_exit_code} -ne 0 ]]; then 34 | echo ${flux_output} 35 | exit 1 36 | fi 37 | 38 | echo "✔ pushed to ${oci_url}" 39 | } 40 | 41 | diff_push "${registry}/flux-cluster-sync:local" "${kubernetes_path}/clusters/${cluster_name}" 42 | diff_push "${registry}/flux-infra-sync:local" "${kubernetes_path}/infra" 43 | diff_push "${registry}/flux-apps-sync:local" "${kubernetes_path}/apps" 44 | -------------------------------------------------------------------------------- /kubernetes/infra/gateway-api.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: fluxcd.controlplane.io/v1 2 | kind: ResourceSet 3 | metadata: 4 | name: gateway-api 5 | namespace: flux-system 6 | annotations: 7 | fluxcd.controlplane.io/reconcileTimeout: "5m" 8 | spec: 9 | inputs: 10 | - channel: experimental # or standard 11 | version: 1.x # auto upgrade to latest minor 12 | interval: 24h # check for updates daily 13 | wait: true 14 | resources: 15 | - apiVersion: source.toolkit.fluxcd.io/v1 16 | kind: GitRepository 17 | metadata: 18 | name: << inputs.provider.name >> 19 | namespace: << inputs.provider.namespace >> 20 | spec: 21 | interval: << inputs.interval | quote >> 22 | url: https://github.com/kubernetes-sigs/gateway-api.git 23 | ref: 24 | semver: << inputs.version | quote >> 25 | - apiVersion: kustomize.toolkit.fluxcd.io/v1 26 | kind: Kustomization 27 | metadata: 28 | name: << inputs.provider.name >> 29 | namespace: << inputs.provider.namespace >> 30 | spec: 31 | serviceAccountName: flux-operator 32 | interval: << inputs.interval | quote >> 33 | retryInterval: 5m 34 | timeout: 3m 35 | prune: true 36 | wait: true 37 | sourceRef: 38 | kind: GitRepository 39 | name: << inputs.provider.name >> 40 | path: config/crd/<< inputs.channel >> 41 | -------------------------------------------------------------------------------- /kubernetes/clusters/local/infra.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: fluxcd.controlplane.io/v1 2 | kind: ResourceSet 3 | metadata: 4 | name: infra 5 | namespace: flux-system 6 | spec: 7 | inputsFrom: 8 | - kind: ResourceSetInputProvider 9 | name: registry 10 | commonMetadata: 11 | labels: 12 | toolkit.fluxcd.io/tenant: platform-team 13 | resources: 14 | - apiVersion: source.toolkit.fluxcd.io/v1 15 | kind: OCIRepository 16 | metadata: 17 | name: infra-source 18 | namespace: << inputs.provider.namespace >> 19 | spec: 20 | interval: 1m 21 | insecure: << inputs.insecure >> 22 | url: "oci://<< inputs.repository >>/flux-infra-sync" 23 | ref: 24 | tag: << inputs.tag | quote >> 25 | - apiVersion: kustomize.toolkit.fluxcd.io/v1 26 | kind: Kustomization 27 | metadata: 28 | name: infra-sync 29 | namespace: << inputs.provider.namespace >> 30 | spec: 31 | interval: 1h 32 | retryInterval: 2m 33 | timeout: 5m 34 | path: ./ 35 | prune: true 36 | wait: true 37 | sourceRef: 38 | kind: OCIRepository 39 | name: infra-source 40 | healthCheckExprs: 41 | - apiVersion: fluxcd.controlplane.io/v1 42 | kind: ResourceSet 43 | current: status.conditions.filter(c, c.type == 'Ready').all(c, c.status == 'True' && c.observedGeneration == metadata.generation) 44 | -------------------------------------------------------------------------------- /kubernetes/infra/cert-manager.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: fluxcd.controlplane.io/v1 2 | kind: ResourceSet 3 | metadata: 4 | name: cert-manager 5 | namespace: flux-system 6 | annotations: 7 | fluxcd.controlplane.io/reconcileTimeout: "5m" 8 | spec: 9 | inputs: 10 | - interval: "1h" # check for updates every hour 11 | version: "*" # upgrade to latest stable version 12 | namespace: cert-manager 13 | commonMetadata: 14 | labels: 15 | toolkit.fluxcd.io/tenant: platform-team 16 | wait: true 17 | resources: 18 | - apiVersion: v1 19 | kind: Namespace 20 | metadata: 21 | name: << inputs.namespace >> 22 | - apiVersion: source.toolkit.fluxcd.io/v1 23 | kind: OCIRepository 24 | metadata: 25 | name: << inputs.provider.name >> 26 | namespace: << inputs.namespace >> 27 | spec: 28 | interval: << inputs.interval | quote >> 29 | url: oci://quay.io/jetstack/charts/cert-manager 30 | layerSelector: 31 | mediaType: "application/vnd.cncf.helm.chart.content.v1.tar+gzip" 32 | operation: copy 33 | ref: 34 | semver: << inputs.version | quote >> 35 | - apiVersion: helm.toolkit.fluxcd.io/v2 36 | kind: HelmRelease 37 | metadata: 38 | name: << inputs.provider.name >> 39 | namespace: << inputs.namespace >> 40 | spec: 41 | interval: 12h 42 | install: 43 | strategy: 44 | name: RetryOnFailure 45 | retryInterval: 2m 46 | upgrade: 47 | strategy: 48 | name: RetryOnFailure 49 | retryInterval: 3m 50 | releaseName: << inputs.provider.name >> 51 | chartRef: 52 | kind: OCIRepository 53 | name: << inputs.provider.name >> 54 | values: 55 | crds: 56 | enabled: true 57 | keep: false 58 | -------------------------------------------------------------------------------- /kubernetes/clusters/local/apps.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: fluxcd.controlplane.io/v1 2 | kind: ResourceSet 3 | metadata: 4 | name: apps 5 | namespace: flux-system 6 | spec: 7 | inputsFrom: 8 | - kind: ResourceSetInputProvider 9 | name: registry 10 | commonMetadata: 11 | labels: 12 | toolkit.fluxcd.io/tenant: dev-team 13 | resources: 14 | - apiVersion: v1 15 | kind: Namespace 16 | metadata: 17 | name: apps 18 | - kind: ServiceAccount 19 | apiVersion: v1 20 | metadata: 21 | name: dev-team 22 | namespace: apps 23 | - apiVersion: rbac.authorization.k8s.io/v1 24 | kind: RoleBinding 25 | metadata: 26 | name: dev-team-reconciler 27 | namespace: apps 28 | roleRef: 29 | apiGroup: rbac.authorization.k8s.io 30 | kind: ClusterRole 31 | name: admin 32 | subjects: 33 | - kind: ServiceAccount 34 | name: dev-team 35 | namespace: apps 36 | - apiVersion: source.toolkit.fluxcd.io/v1 37 | kind: OCIRepository 38 | metadata: 39 | name: apps-source 40 | namespace: << inputs.provider.namespace >> 41 | spec: 42 | interval: 1m 43 | insecure: << inputs.insecure >> 44 | url: "oci://<< inputs.repository >>/flux-apps-sync" 45 | ref: 46 | tag: << inputs.tag | quote >> 47 | - apiVersion: kustomize.toolkit.fluxcd.io/v1 48 | kind: Kustomization 49 | metadata: 50 | name: apps-sync 51 | namespace: << inputs.provider.namespace >> 52 | spec: 53 | dependsOn: 54 | - name: infra-sync 55 | interval: 1h 56 | retryInterval: 1m 57 | timeout: 5m 58 | path: ./ 59 | prune: true 60 | wait: true 61 | sourceRef: 62 | kind: OCIRepository 63 | name: apps-source 64 | healthCheckExprs: 65 | - apiVersion: fluxcd.controlplane.io/v1 66 | kind: ResourceSet 67 | current: status.conditions.filter(c, c.type == 'Ready').all(c, c.status == 'True' && c.observedGeneration == metadata.generation) 68 | -------------------------------------------------------------------------------- /kubernetes/infra/metrics-server.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: fluxcd.controlplane.io/v1 2 | kind: ResourceSet 3 | metadata: 4 | name: metrics-server 5 | namespace: flux-system 6 | annotations: 7 | fluxcd.controlplane.io/reconcileTimeout: "5m" 8 | spec: 9 | dependsOn: 10 | - apiVersion: fluxcd.controlplane.io/v1 11 | kind: ResourceSet 12 | name: cert-manager 13 | namespace: flux-system 14 | ready: true 15 | inputs: 16 | - interval: "1h" # check for updates every hour 17 | version: "*" # upgrade to latest stable version 18 | namespace: monitoring 19 | commonMetadata: 20 | labels: 21 | toolkit.fluxcd.io/tenant: platform-team 22 | wait: true 23 | resources: 24 | - apiVersion: v1 25 | kind: Namespace 26 | metadata: 27 | name: << inputs.namespace >> 28 | - apiVersion: source.toolkit.fluxcd.io/v1 29 | kind: OCIRepository 30 | metadata: 31 | name: << inputs.provider.name >> 32 | namespace: << inputs.namespace >> 33 | spec: 34 | interval: << inputs.interval | quote >> 35 | url: oci://ghcr.io/controlplaneio-fluxcd/charts/metrics-server 36 | layerSelector: 37 | mediaType: "application/vnd.cncf.helm.chart.content.v1.tar+gzip" 38 | operation: copy 39 | ref: 40 | semver: << inputs.version | quote >> 41 | - apiVersion: helm.toolkit.fluxcd.io/v2 42 | kind: HelmRelease 43 | metadata: 44 | name: << inputs.provider.name >> 45 | namespace: << inputs.namespace >> 46 | spec: 47 | interval: 12h 48 | install: 49 | strategy: 50 | name: RetryOnFailure 51 | retryInterval: 2m 52 | upgrade: 53 | strategy: 54 | name: RetryOnFailure 55 | retryInterval: 3m 56 | releaseName: << inputs.provider.name >> 57 | chartRef: 58 | kind: OCIRepository 59 | name: << inputs.provider.name >> 60 | values: 61 | apiService: 62 | insecureSkipTLSVerify: false 63 | tls: 64 | type: cert-manager 65 | args: 66 | - --kubelet-insecure-tls 67 | -------------------------------------------------------------------------------- /scripts/kind-up.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # Copyright 2024 Stefan Prodan 4 | # SPDX-License-Identifier: AGPL-3.0 5 | 6 | set -o errexit 7 | 8 | cluster_name="${CLUSTER_NAME:=flux}" 9 | cluster_version="${CLUSTER_VERSION:=v1.33.4}" 10 | reg_name="${cluster_name}-registry" 11 | reg_localhost_port="5050" 12 | reg_cluster_port="5000" 13 | 14 | install_cluster() { 15 | cat </dev/null || true)" != 'true' ]; then 50 | echo "starting Docker registry on localhost:${reg_localhost_port}" 51 | docker run -d --restart=always -p "127.0.0.1:${reg_localhost_port}:${reg_cluster_port}" \ 52 | --name "${reg_name}" registry:3 53 | fi 54 | 55 | # Create a cluster with the local registry enabled 56 | if [ "$(kind get clusters | grep ${cluster_name})" != "${cluster_name}" ]; then 57 | install_cluster 58 | register_registry 59 | else 60 | echo "cluster ${cluster_name} exists" 61 | fi 62 | 63 | # Connect the registry to the cluster network 64 | if [ "$(docker inspect -f='{{json .NetworkSettings.Networks.kind}}' "${reg_name}")" = 'null' ]; then 65 | echo "connecting the Docker registry to the cluster network" 66 | docker network connect "kind" "${reg_name}" 67 | fi 68 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Stefan Prodan. 2 | # SPDX-License-Identifier: AGPL-3.0 3 | 4 | # Makefile for deploying the Flux Operator on a Kubernetes KinD cluster 5 | # using a local registry as the cluster desired state. 6 | 7 | # Prerequisites: 8 | # - Docker 9 | # - Kind 10 | # - Kubectl 11 | # - Flux CLI 12 | # - Flux Operator CLI 13 | 14 | SHELL = /usr/bin/env bash -o pipefail 15 | .SHELLFLAGS = -ec 16 | 17 | .PHONY: all 18 | all: up 19 | 20 | ##@ General 21 | 22 | .PHONY: up 23 | up: cluster-up flux-push flux-up ## Create the local cluster and registry, install Flux and the cluster addons 24 | 25 | .PHONY: down 26 | down: cluster-down ## Delete the local cluster and registry 27 | 28 | .PHONY: sync 29 | sync: flux-push flux-sync ## Build, push and reconcile the local manifests with the cluster 30 | 31 | .PHONY: ls 32 | ls: ## List all deployed resources 33 | flux-operator -n flux-system tree ks flux-system 34 | 35 | ##@ Cluster 36 | 37 | cluster-up: ## Creates a Kubernetes KinD cluster and a local registry bind to localhost:5050. 38 | ./scripts/kind-up.sh 39 | 40 | cluster-down: ## Shutdown the Kubernetes KinD cluster and the local registry. 41 | ./scripts/kind-down.sh 42 | 43 | ##@ Artifacts 44 | 45 | flux-push: ## Push the Kubernetes manifests to the local registry. 46 | ./scripts/flux-push.sh 47 | 48 | ##@ Flux 49 | 50 | flux-up: ## Deploy Flux Operator on the Kubernetes KinD cluster. 51 | ./scripts/flux-up.sh 52 | 53 | flux-sync: ## Sync the local cluster with the cluster. 54 | ./scripts/flux-sync.sh 55 | 56 | ##@ Tools 57 | 58 | tools: ## Install Kubernetes kind, kubectl, FLux CLI and Helm Homebrew 59 | brew bundle 60 | 61 | ## Location to install Go tools 62 | LOCALBIN ?= $(shell pwd)/bin 63 | $(LOCALBIN): 64 | mkdir -p $(LOCALBIN) 65 | 66 | # go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist 67 | # $1 - target path with name of binary (ideally with version) 68 | # $2 - package url which can be installed 69 | # $3 - specific version of package 70 | define go-install-tool 71 | @[ -f $(1) ] || { \ 72 | set -e; \ 73 | package=$(2)@$(3) ;\ 74 | echo "Downloading $${package}" ;\ 75 | GOBIN=$(LOCALBIN) go install $${package} ;\ 76 | mv "$$(echo "$(1)" | sed "s/-$(3)$$//")" $(1) ;\ 77 | } 78 | endef 79 | 80 | .PHONY: help 81 | help: ## Display this help. 82 | @awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) 83 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # flux-operator-local-dev 2 | 3 | [![test](https://github.com/controlplaneio-fluxcd/flux-operator-local-dev/actions/workflows/test.yaml/badge.svg)](https://github.com/controlplaneio-fluxcd/flux-operator-local-dev/actions/workflows/test.yaml) 4 | [![license](https://img.shields.io/github/license/controlplaneio-fluxcd/flux-operator-local-dev.svg)](https://github.com/controlplaneio-fluxcd/flux-operator-local-dev/blob/main/LICENSE) 5 | 6 | [Flux Operator](https://github.com/controlplaneio-fluxcd/flux-operator) 7 | local dev environment with Docker and Kubernetes KIND. 8 | 9 | ## Get started 10 | 11 | ### Prerequisites 12 | 13 | Start by cloning the repository locally: 14 | 15 | ```shell 16 | git clone https://github.com/controlplaneio-fluxcd/flux-operator-local-dev.git 17 | cd flux-operator-local-dev 18 | ``` 19 | 20 | The following tools are required: 21 | 22 | - [Docker](https://docs.docker.com/get-docker/) 23 | - [Kubernetes KIND](https://kind.sigs.k8s.io/docs/user/quick-start/) 24 | - [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) 25 | - [Flux CLI](https://fluxcd.io/docs/installation/) 26 | - [Flux Operator CLI](https://fluxcd.control-plane.io/operator/cli/) 27 | 28 | On macOS, you can install all the required tools with Homebrew by running: 29 | 30 | ```shell 31 | make tools 32 | ``` 33 | 34 | ### Bootstrap 35 | 36 | Start the dev environment with: 37 | 38 | ```shell 39 | make up 40 | ``` 41 | 42 | The `make up` command performs the following steps: 43 | - creates the Docker registry container if it's not already running and exposes it on `localhost:5050` 44 | - creates the Kubernetes Kind cluster if it's not already running 45 | - pushes the Kubernetes manifests as OCI artifacts to the local registry 46 | - `locahost:5050/flux-cluster-sync` is generated from `kubernetes/clusters/local` 47 | - `locahost:5050/flux-infra-sync` is generated from `kubernetes/infra` 48 | - `locahost:5050/flux-apps-sync` is generated from `kubernetes/apps` 49 | - installs Flux Operator on the cluster and configures it to reconcile the manifests from the local registry 50 | - waits for Flux to reconcile the cluster addons from `oci://flux-registry:5000/flux-infra-sync` 51 | - waits for Flux to reconcile the demo apps from `oci://flux-registry:5000/flux-apps-sync` 52 | 53 | To list all deployed resources, run: 54 | 55 | ```shell 56 | make ls 57 | ``` 58 | 59 | ### Sync changes 60 | 61 | To sync changes to the Kubernetes manifests, run: 62 | 63 | ```shell 64 | make sync 65 | ``` 66 | 67 | The `make sync` command pushes the Kubernetes manifests to the local registry 68 | and waits for Flux to reconcile the changes on the cluster. 69 | 70 | ### Tear down 71 | 72 | To tear down the dev environment, run: 73 | 74 | ```shell 75 | make down 76 | ``` 77 | 78 | The `make down` command deletes the Kind cluster and the Docker registry container. 79 | -------------------------------------------------------------------------------- /kubernetes/apps/redis.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: fluxcd.controlplane.io/v1 2 | kind: ResourceSetInputProvider 3 | metadata: 4 | name: redis-latest 5 | namespace: apps 6 | spec: 7 | type: OCIArtifactTag 8 | url: oci://docker.io/redis 9 | filter: 10 | semver: ">0.0.0-0" 11 | includeTag: ".*-alpine$" 12 | limit: 1 13 | schedule: 14 | - cron: "0 10 * * 1-4" 15 | timeZone: UTC 16 | --- 17 | apiVersion: fluxcd.controlplane.io/v1 18 | kind: ResourceSet 19 | metadata: 20 | name: redis 21 | namespace: apps 22 | annotations: 23 | fluxcd.controlplane.io/reconcileTimeout: "5m" 24 | spec: 25 | inputsFrom: 26 | - kind: ResourceSetInputProvider 27 | name: redis-latest 28 | serviceAccountName: dev-team 29 | commonMetadata: 30 | labels: 31 | app.kubernetes.io/name: redis 32 | wait: true 33 | resources: 34 | - apiVersion: v1 35 | kind: ServiceAccount 36 | metadata: 37 | name: redis 38 | namespace: << inputs.provider.namespace >> 39 | - apiVersion: v1 40 | kind: ConfigMap 41 | metadata: 42 | name: redis-config 43 | namespace: << inputs.provider.namespace >> 44 | data: 45 | redis.conf: | 46 | maxmemory 64mb 47 | maxmemory-policy allkeys-lru 48 | save "" 49 | appendonly no 50 | - apiVersion: apps/v1 51 | kind: Deployment 52 | metadata: 53 | name: redis 54 | namespace: << inputs.provider.namespace >> 55 | spec: 56 | selector: 57 | matchLabels: 58 | app.kubernetes.io/name: redis 59 | template: 60 | metadata: 61 | labels: 62 | app.kubernetes.io/name: redis 63 | spec: 64 | serviceAccountName: redis 65 | securityContext: 66 | runAsNonRoot: true 67 | runAsUser: 999 68 | fsGroup: 1000 69 | seccompProfile: 70 | type: RuntimeDefault 71 | containers: 72 | - name: redis 73 | image: redis:<< inputs.tag >>@<< inputs.digest >> 74 | imagePullPolicy: IfNotPresent 75 | securityContext: 76 | allowPrivilegeEscalation: false 77 | readOnlyRootFilesystem: true 78 | runAsNonRoot: true 79 | capabilities: 80 | drop: 81 | - ALL 82 | command: 83 | - redis-server 84 | - "/redis-master/redis.conf" 85 | ports: 86 | - name: redis 87 | containerPort: 6379 88 | protocol: TCP 89 | livenessProbe: 90 | tcpSocket: 91 | port: redis 92 | initialDelaySeconds: 5 93 | timeoutSeconds: 5 94 | readinessProbe: 95 | exec: 96 | command: 97 | - redis-cli 98 | - ping 99 | initialDelaySeconds: 5 100 | timeoutSeconds: 5 101 | resources: 102 | limits: 103 | cpu: 1000m 104 | memory: 128Mi 105 | requests: 106 | cpu: 100m 107 | memory: 32Mi 108 | volumeMounts: 109 | - mountPath: /var/lib/redis 110 | name: data 111 | - mountPath: /redis-master 112 | name: config 113 | volumes: 114 | - name: data 115 | emptyDir: {} 116 | - name: config 117 | configMap: 118 | name: redis-config 119 | items: 120 | - key: redis.conf 121 | path: redis.conf 122 | - apiVersion: v1 123 | kind: Service 124 | metadata: 125 | name: redis 126 | namespace: << inputs.provider.namespace >> 127 | spec: 128 | type: ClusterIP 129 | selector: 130 | app.kubernetes.io/name: redis 131 | ports: 132 | - name: redis 133 | port: 6379 134 | protocol: TCP 135 | targetPort: redis 136 | -------------------------------------------------------------------------------- /kubernetes/apps/podinfo.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: fluxcd.controlplane.io/v1 2 | kind: ResourceSetInputProvider 3 | metadata: 4 | name: podinfo-latest 5 | namespace: apps 6 | annotations: 7 | fluxcd.controlplane.io/reconcileEvery: "5m" 8 | spec: 9 | type: OCIArtifactTag 10 | url: oci://ghcr.io/stefanprodan/podinfo 11 | filter: 12 | semver: "*" 13 | limit: 1 14 | --- 15 | apiVersion: fluxcd.controlplane.io/v1 16 | kind: ResourceSet 17 | metadata: 18 | name: podinfo 19 | namespace: apps 20 | annotations: 21 | fluxcd.controlplane.io/reconcileTimeout: "5m" 22 | spec: 23 | inputsFrom: 24 | - kind: ResourceSetInputProvider 25 | name: podinfo-latest 26 | dependsOn: 27 | - apiVersion: apps/v1 28 | kind: Deployment 29 | name: redis 30 | namespace: apps 31 | ready: true 32 | serviceAccountName: dev-team 33 | commonMetadata: 34 | labels: 35 | app.kubernetes.io/name: podinfo 36 | wait: true 37 | resources: 38 | - apiVersion: v1 39 | kind: ServiceAccount 40 | metadata: 41 | name: podinfo 42 | namespace: << inputs.provider.namespace >> 43 | - apiVersion: apps/v1 44 | kind: Deployment 45 | metadata: 46 | name: podinfo 47 | namespace: << inputs.provider.namespace >> 48 | spec: 49 | selector: 50 | matchLabels: 51 | app.kubernetes.io/name: podinfo 52 | template: 53 | metadata: 54 | annotations: 55 | prometheus.io/scrape: "true" 56 | prometheus.io/port: "9797" 57 | labels: 58 | app.kubernetes.io/name: podinfo 59 | spec: 60 | serviceAccountName: podinfo 61 | securityContext: 62 | runAsNonRoot: true 63 | runAsUser: 65534 64 | fsGroup: 65534 65 | seccompProfile: 66 | type: RuntimeDefault 67 | containers: 68 | - name: podinfod 69 | image: ghcr.io/stefanprodan/podinfo:<< inputs.tag >>@<< inputs.digest >> 70 | imagePullPolicy: IfNotPresent 71 | securityContext: 72 | allowPrivilegeEscalation: false 73 | readOnlyRootFilesystem: true 74 | runAsNonRoot: true 75 | capabilities: 76 | drop: 77 | - ALL 78 | ports: 79 | - name: http 80 | containerPort: 9898 81 | protocol: TCP 82 | - name: http-metrics 83 | containerPort: 9797 84 | protocol: TCP 85 | - name: grpc 86 | containerPort: 9999 87 | protocol: TCP 88 | command: 89 | - ./podinfo 90 | - --port=9898 91 | - --port-metrics=9797 92 | - --grpc-port=9999 93 | - --grpc-service-name=podinfo 94 | - --level=info 95 | - --cache-server=tcp://redis.<< inputs.provider.namespace >>.svc:6379 96 | env: 97 | - name: PODINFO_UI_COLOR 98 | value: "#34577c" 99 | livenessProbe: 100 | httpGet: 101 | path: /healthz 102 | port: http 103 | readinessProbe: 104 | httpGet: 105 | path: /readyz 106 | port: http 107 | resources: 108 | limits: 109 | cpu: 2000m 110 | memory: 512Mi 111 | requests: 112 | cpu: 100m 113 | memory: 64Mi 114 | volumeMounts: 115 | - name: data 116 | mountPath: /data 117 | volumes: 118 | - name: data 119 | emptyDir: {} 120 | - apiVersion: v1 121 | kind: Service 122 | metadata: 123 | name: podinfo 124 | namespace: << inputs.provider.namespace >> 125 | spec: 126 | type: ClusterIP 127 | selector: 128 | app.kubernetes.io/name: podinfo 129 | ports: 130 | - name: http 131 | port: 9898 132 | protocol: TCP 133 | targetPort: http 134 | - port: 9999 135 | targetPort: grpc 136 | protocol: TCP 137 | name: grpc 138 | - apiVersion: autoscaling/v2 139 | kind: HorizontalPodAutoscaler 140 | metadata: 141 | name: podinfo 142 | namespace: << inputs.provider.namespace >> 143 | spec: 144 | scaleTargetRef: 145 | apiVersion: apps/v1 146 | kind: Deployment 147 | name: podinfo 148 | minReplicas: 2 149 | maxReplicas: 4 150 | metrics: 151 | - type: Resource 152 | resource: 153 | name: cpu 154 | target: 155 | type: Utilization 156 | averageUtilization: 99 157 | -------------------------------------------------------------------------------- /CLAUDE.md: -------------------------------------------------------------------------------- 1 | # CLAUDE.md 2 | 3 | This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. 4 | 5 | ## Repository Overview 6 | 7 | This is a local development environment for the [Flux Operator](https://github.com/controlplaneio-fluxcd/flux-operator) using Docker and Kubernetes KIND. It demonstrates GitOps-style continuous delivery using OCI artifacts stored in a local registry instead of Git repositories. 8 | 9 | ## Common Commands 10 | 11 | ### Environment Management 12 | - `make up` - Create KIND cluster, local registry, install Flux Operator, and deploy infrastructure and apps 13 | - `make down` - Tear down the entire environment (deletes cluster and registry) 14 | - `make sync` - Push local manifest changes to registry and reconcile with cluster 15 | - `make tools` - Install all required tools via Homebrew (macOS only) 16 | 17 | ### Flux Operations 18 | - `flux-operator -n flux-system tree ks flux-system` - List all deployed resources 19 | - `flux tree kustomization apps-sync` - View application resources tree 20 | - `flux reconcile kustomization infra-sync --with-source` - Force reconcile infrastructure 21 | - `flux reconcile kustomization apps-sync --with-source` - Force reconcile applications 22 | 23 | ### Registry 24 | - Local registry runs on `localhost:5050` (external) and `flux-registry:5000` (internal to cluster) 25 | - Manifests are packaged as OCI artifacts and pushed to registry before deployment 26 | 27 | ## Architecture 28 | 29 | ### Three-Tier Resource Organization 30 | 31 | 1. **Cluster Sync Layer** (`kubernetes/clusters/local/`) 32 | - Entry point for the cluster configuration 33 | - Defines `ResourceSetInputProvider` for registry configuration 34 | - Creates two main `ResourceSet` objects: `infra` and `apps` 35 | - Sets up namespaces and RBAC (platform-team, dev-team service accounts) 36 | 37 | 2. **Infrastructure Layer** (`kubernetes/infra/`) 38 | - Platform-level components managed by `platform-team` 39 | - Installed in order with dependencies: metrics-server → cert-manager → cluster-issuers 40 | - Uses `dependsOn` with `readyExpr` for proper ordering 41 | 42 | 3. **Application Layer** (`kubernetes/apps/`) 43 | - User workloads managed by `dev-team` 44 | - Demo apps: podinfo (web app with Redis cache backend) 45 | - Apps depend on infrastructure being ready first 46 | 47 | ### ResourceSet Pattern 48 | 49 | This repo uses the Flux Operator's [ResourceSet](https://raw.githubusercontent.com/controlplaneio-fluxcd/flux-operator/refs/heads/main/docs/api/v1/resourceset.md) and [ResourceSetInputProvider](https://raw.githubusercontent.com/controlplaneio-fluxcd/flux-operator/refs/heads/main/docs/api/v1/resourcesetinputprovider.md) APIs extensively: 50 | 51 | **ResourceSetInputProvider**: Provides dynamic inputs to ResourceSets 52 | - `OCIArtifactTag` type - fetches container image tags (e.g., latest Redis Alpine version) 53 | - `Static` type - provides static configuration values (e.g., registry URL) 54 | - Can define schedules (cron) for checking updates 55 | 56 | **ResourceSet**: Groups related Kubernetes resources with templating 57 | - Uses Go template syntax with `<< >>` delimiters (e.g., `<< inputs.tag >>`) 58 | - `commonMetadata` - applies labels to all resources 59 | - `dependsOn` - declares dependencies on other resources with readiness checks 60 | - `wait` - waits for all resources to become ready before reconciliation completes 61 | - `serviceAccountName` - specifies which service account reconciles the ResourceSet 62 | 63 | ### OCI Artifact Workflow 64 | 65 | 1. Local manifests organized in `kubernetes/` directory 66 | 2. `flux push artifact` packages directories as OCI artifacts 67 | 3. Artifacts pushed to local registry with `local` tag 68 | 4. Flux Operator pulls artifacts and applies them to cluster 69 | 5. Changes detected via `flux diff artifact` before pushing 70 | 71 | Three OCI artifacts: 72 | - `flux-cluster-sync:local` - from `kubernetes/clusters/local/` 73 | - `flux-infra-sync:local` - from `kubernetes/infra/` 74 | - `flux-apps-sync:local` - from `kubernetes/apps/` 75 | 76 | ## Security Patterns 77 | 78 | All workloads in this repo follow security best practices: 79 | 80 | **Pod Security Context:** 81 | - `runAsNonRoot: true` 82 | - `runAsUser: ` (999 for Redis, 65534 for podinfo) 83 | - `fsGroup: ` (1000 for Redis Alpine, 65534 for podinfo) 84 | - `seccompProfile.type: RuntimeDefault` 85 | 86 | **Container Security Context:** 87 | - `allowPrivilegeEscalation: false` 88 | - `readOnlyRootFilesystem: true` 89 | - `runAsNonRoot: true` 90 | - `capabilities.drop: [ALL]` 91 | 92 | **Service Accounts:** 93 | - Every deployment has its own ServiceAccount 94 | - ResourceSets specify `serviceAccountName` for RBAC isolation 95 | 96 | ## Development Workflow 97 | 98 | ### Making Changes to Manifests 99 | 100 | 1. Edit files in `kubernetes/apps/` or `kubernetes/infra/` 101 | 2. Run `make sync` to push to registry and reconcile 102 | 3. Flux automatically detects changes and applies them 103 | 4. Use `flux tree kustomization ` to verify deployment 104 | 105 | ### Adding New Applications 106 | 107 | Follow the pattern in `kubernetes/apps/podinfo.yaml`: 108 | 109 | 1. Create `ResourceSetInputProvider` for dynamic inputs (e.g., latest container tag) 110 | 2. Create `ResourceSet` with: 111 | - `inputsFrom` referencing the provider 112 | - `commonMetadata.labels` for consistent labeling 113 | - `dependsOn` if app depends on other resources 114 | - Resources array with ServiceAccount, Deployment, Service, etc. 115 | 3. Add security contexts at pod and container level 116 | 4. Use templating for dynamic values: `<< inputs.tag >>`, `<< inputs.provider.namespace >>` 117 | 118 | ### Label Conventions 119 | 120 | - Use `app.kubernetes.io/name` for workload labels (not `app`) 121 | - ResourceSets are labeled with `toolkit.fluxcd.io/tenant` (platform-team or dev-team) 122 | 123 | ## Key Files 124 | 125 | - `Makefile` - Primary interface for all operations 126 | - `scripts/kind-up.sh` - Creates KIND cluster with registry 127 | - `scripts/flux-up.sh` - Installs Flux Operator and instance 128 | - `scripts/flux-push.sh` - Packages and pushes manifests as OCI artifacts 129 | - `scripts/flux-sync.sh` - Forces reconciliation of all Kustomizations 130 | - `kubernetes/clusters/local/registry.yaml` - Registry configuration provider 131 | - `kubernetes/clusters/local/infra.yaml` - Infrastructure sync setup 132 | - `kubernetes/clusters/local/apps.yaml` - Applications sync setup 133 | 134 | ## Testing 135 | 136 | The repository includes GitHub Actions workflow (`.github/workflows/test.yaml`) that validates the setup. -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------