├── .flux.yaml ├── LICENSE ├── README.md ├── base ├── demo-ns.yaml ├── kustomization.yaml ├── podinfo-dep.yaml ├── podinfo-hpa.yaml └── podinfo-svc.yaml ├── production ├── flux-patch.yaml ├── kustomization.yaml └── replicas-patch.yaml └── staging ├── flux-patch.yaml └── kustomization.yaml /.flux.yaml: -------------------------------------------------------------------------------- 1 | version: 1 2 | patchUpdated: 3 | generators: 4 | - command: kustomize build . 5 | patchFile: flux-patch.yaml 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Using Flux with Kustomize 2 | 3 | ## We are moving to Flux v2 4 | 5 | > ⚠️ Please note: In preparation of [Flux v2](https://toolkit.fluxcd.io/) GA this repository with Flux v1 examples has been archived. The Flux v2 equivalent of what is shown here can be found at [flux2-kustomize-helm-example](https://github.com/fluxcd/flux2-kustomize-helm-example). 6 | > 7 | > Thanks a lot for your interest. 8 | 9 | ## For posterity 10 | 11 | ### Scenario and Goals 12 | 13 | The following example makes use of Flux's manifest-generation feature 14 | together with [Kustomize](https://github.com/kubernetes-sigs/kustomize) (and other such tooling, in theory). 15 | 16 | For this example we assume an scenario with two clusters, `staging` and 17 | `production`. The goal is to levarage the full functionality of Flux (including 18 | automatic releases and supporting all `fluxctl` commands) to manage both 19 | clusters while minimizing duplicated declarations. 20 | 21 | `staging` and `production` are almost identical, they both deploy a 22 | [`podinfo`](https://github.com/stefanprodan/k8s-podinfo) service. However, we 23 | have different requirments for each cluster: 24 | 25 | 1. We want automated deployments for `staging` but not for `production` since we want a rubber-stamp 26 | every change. However, we want to still be able to make the changes with `fluxctl`. 27 | 2. Since we expect `production` to have a higher load than `staging`, we want a higher replica range there. 28 | 29 | ### How to run the example 30 | 31 | In order to run this example, you need to: 32 | 33 | 1. Deploy Flux version 1.13.0 or newer. 34 | 35 | 2. Make sure to pass the flag `--manifest-generation=true` to fluxd, in its container spec. 36 | 37 | 3. Fork this repository and add the fork's URL as the `--git-url` flag for the fluxd container. 38 | 39 | 4. Pick an environment to run (`staging` or `production`) and ask Flux to use 40 | that environment by passing flag `--git-path=staging` or `--git-path=production` 41 | 42 | 5. As usual, you need to make sure that the ssh key shown by `fluxctl identity` 43 | is added to the your github fork. 44 | 45 | ### How does this example work? 46 | 47 | ``` 48 | ├── .flux.yaml 49 | ├── base 50 | │ ├── demo-ns.yaml 51 | │ ├── kustomization.yaml 52 | │ ├── podinfo-dep.yaml 53 | │ ├── podinfo-hpa.yaml 54 | │ └── podinfo-svc.yaml 55 | ├── staging 56 | │ ├── flux-patch.yaml 57 | │ └── kustomization.yaml 58 | └── production 59 | ├── flux-patch.yaml 60 | ├── kustomization.yaml 61 | └── replicas-patch.yaml 62 | ``` 63 | 64 | * `base` contains the base manifests. The resources to be deployed in 65 | `staging` and `production` are almost identical to the ones described here. 66 | * the `staging` and `production` directories make use of `base`, with a few patches, 67 | to generate the final manifests for each environment: 68 | * `staging/kustomization.yaml` and `production/kustomization.yaml` 69 | are Kustomize config files which indicate how to apply the patches. 70 | * `staging/flux-patch.yaml` and `production/flux-patch.yaml` contain 71 | environment-specific Flux [annotations](https://docs.fluxcd.io/en/latest/tutorials/driving-flux/) 72 | and the container images to be deployed in each environment. 73 | * `production/replicas-patch.yaml` increases the number of replicas of podinfo in production. 74 | * `.flux.yaml` is used by Flux to generate and update manifests. 75 | Its commands are run in the directory (`staging` or `production`). 76 | In this particular case, `.flux.yaml` tells Flux to generate manifests running 77 | `kustomize build` and update policy annotations and container images by editing 78 | `flux-patch.yaml`, which will implicitly applied to the manifests generated with 79 | `kustomize build`. 80 | 81 | ### I want to know more 82 | 83 | For a more sophisticated example of using Flux with Kustomize for creating a 84 | multitenant cluster you can go to https://github.com/fluxcd/multi-tenancy . 85 | 86 | For more details about how `.flux.yaml` files work you can read the 87 | [reference documentation](https://docs.fluxcd.io/en/latest/references/fluxyaml-config-files/) 88 | -------------------------------------------------------------------------------- /base/demo-ns.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1 2 | kind: Namespace 3 | metadata: 4 | labels: 5 | name: demo 6 | name: demo 7 | -------------------------------------------------------------------------------- /base/kustomization.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: kustomize.config.k8s.io/v1beta1 2 | kind: Kustomization 3 | resources: 4 | - podinfo-dep.yaml 5 | - podinfo-hpa.yaml 6 | - podinfo-svc.yaml 7 | - demo-ns.yaml 8 | -------------------------------------------------------------------------------- /base/podinfo-dep.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: apps/v1 3 | kind: Deployment 4 | metadata: 5 | name: podinfo 6 | namespace: demo 7 | labels: 8 | app: podinfo 9 | spec: 10 | strategy: 11 | rollingUpdate: 12 | maxUnavailable: 0 13 | type: RollingUpdate 14 | selector: 15 | matchLabels: 16 | app: podinfo 17 | template: 18 | metadata: 19 | annotations: 20 | prometheus.io/scrape: "true" 21 | labels: 22 | app: podinfo 23 | spec: 24 | initContainers: 25 | - name: init 26 | image: alpine:3.9 27 | command: 28 | - sleep 29 | - "1" 30 | containers: 31 | - name: podinfod 32 | image: stefanprodan/podinfo:1.3.2 33 | imagePullPolicy: IfNotPresent 34 | ports: 35 | - containerPort: 9898 36 | name: http 37 | protocol: TCP 38 | command: 39 | - ./podinfo 40 | - --port=9898 41 | - --level=info 42 | - --random-delay=false 43 | - --random-error=false 44 | env: 45 | - name: PODINFO_UI_COLOR 46 | value: green 47 | livenessProbe: 48 | httpGet: 49 | path: /healthz 50 | port: 9898 51 | readinessProbe: 52 | httpGet: 53 | path: /readyz 54 | port: 9898 55 | resources: 56 | limits: 57 | cpu: 1000m 58 | memory: 128Mi 59 | requests: 60 | cpu: 10m 61 | memory: 64Mi 62 | -------------------------------------------------------------------------------- /base/podinfo-hpa.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: autoscaling/v2beta1 2 | kind: HorizontalPodAutoscaler 3 | metadata: 4 | name: podinfo 5 | namespace: demo 6 | spec: 7 | scaleTargetRef: 8 | apiVersion: apps/v1 9 | kind: Deployment 10 | name: podinfo 11 | minReplicas: 1 12 | maxReplicas: 2 13 | metrics: 14 | - type: Resource 15 | resource: 16 | name: cpu 17 | # scale up if usage is above 18 | # 99% of the requested CPU (10m) 19 | targetAverageUtilization: 99 20 | -------------------------------------------------------------------------------- /base/podinfo-svc.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1 2 | kind: Service 3 | metadata: 4 | name: podinfo 5 | namespace: demo 6 | labels: 7 | app: podinfo 8 | spec: 9 | type: ClusterIP 10 | selector: 11 | app: podinfo 12 | ports: 13 | - name: http 14 | port: 9898 15 | protocol: TCP 16 | targetPort: http 17 | -------------------------------------------------------------------------------- /production/flux-patch.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: apps/v1 3 | kind: Deployment 4 | metadata: 5 | annotations: 6 | flux.weave.works/locked: "true" 7 | flux.weave.works/locked_msg: Lock deployment in production 8 | flux.weave.works/locked_user: Alfonso Acosta 9 | name: podinfo 10 | namespace: demo 11 | -------------------------------------------------------------------------------- /production/kustomization.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: kustomize.config.k8s.io/v1beta1 2 | kind: Kustomization 3 | bases: 4 | - ../base/ 5 | patchesStrategicMerge: 6 | - replicas-patch.yaml 7 | -------------------------------------------------------------------------------- /production/replicas-patch.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: autoscaling/v2beta1 3 | kind: HorizontalPodAutoscaler 4 | metadata: 5 | name: podinfo 6 | namespace: demo 7 | spec: 8 | minReplicas: 2 9 | maxReplicas: 4 10 | -------------------------------------------------------------------------------- /staging/flux-patch.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: apps/v1 3 | kind: Deployment 4 | metadata: 5 | annotations: 6 | flux.weave.works/automated: "true" 7 | flux.weave.works/tag.init: regexp:^3.* 8 | flux.weave.works/tag.podinfod: semver:~1.4 9 | name: podinfo 10 | namespace: demo 11 | spec: 12 | template: 13 | spec: 14 | $setElementOrder/containers: 15 | - name: podinfod 16 | containers: 17 | - image: stefanprodan/podinfo:1.4.4 18 | name: podinfod 19 | -------------------------------------------------------------------------------- /staging/kustomization.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: kustomize.config.k8s.io/v1beta1 2 | kind: Kustomization 3 | bases: 4 | - ../base/ 5 | --------------------------------------------------------------------------------