From 7100995d6ef163fc76957418434fba1d6ead3635 Mon Sep 17 00:00:00 2001 From: Christoph Mewes Date: Thu, 9 Jan 2025 21:01:08 +0100 Subject: [PATCH 1/7] add basic chart for the new api-syncagent On-behalf-of: @SAP christoph.mewes@sap.com --- charts/api-syncagent/Chart.yaml | 20 ++ charts/api-syncagent/LICENSE | 202 ++++++++++++++++++ charts/api-syncagent/README.md | 3 + charts/api-syncagent/templates/_helpers.tpl | 11 + .../api-syncagent/templates/deployment.yaml | 80 +++++++ charts/api-syncagent/templates/rbac.yaml | 115 ++++++++++ charts/api-syncagent/values.yaml | 47 ++++ 7 files changed, 478 insertions(+) create mode 100644 charts/api-syncagent/Chart.yaml create mode 100644 charts/api-syncagent/LICENSE create mode 100644 charts/api-syncagent/README.md create mode 100644 charts/api-syncagent/templates/_helpers.tpl create mode 100644 charts/api-syncagent/templates/deployment.yaml create mode 100644 charts/api-syncagent/templates/rbac.yaml create mode 100644 charts/api-syncagent/values.yaml diff --git a/charts/api-syncagent/Chart.yaml b/charts/api-syncagent/Chart.yaml new file mode 100644 index 0000000..4c3ce38 --- /dev/null +++ b/charts/api-syncagent/Chart.yaml @@ -0,0 +1,20 @@ +apiVersion: v2 +name: api-syncagent +description: A Kubernetes agent to synchronize APIs and their objects between Kubernetes clusters and kcp. + +# version information +version: 0.0.1 +appVersion: "0.0.0" + +# optional metadata +type: application +home: https://www.kcp.io/ +keywords: + - kcp + - kubernetes + - multitenancy + - controlplane +sources: + - https://github.com/kcp-dev/helm-charts + - https://github.com/kcp-dev/api-syncagent +icon: https://raw.githubusercontent.com/kcp-dev/kcp/main/contrib/logo/blue-green.svg diff --git a/charts/api-syncagent/LICENSE b/charts/api-syncagent/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/charts/api-syncagent/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/charts/api-syncagent/README.md b/charts/api-syncagent/README.md new file mode 100644 index 0000000..d6720a4 --- /dev/null +++ b/charts/api-syncagent/README.md @@ -0,0 +1,3 @@ +# KCP Helm Chart - Sync Agent + +This Helm chart deploys an instance of the [Sync Agent](https://github.com/kcp-dev/api-syncagent). diff --git a/charts/api-syncagent/templates/_helpers.tpl b/charts/api-syncagent/templates/_helpers.tpl new file mode 100644 index 0000000..2a1a5c7 --- /dev/null +++ b/charts/api-syncagent/templates/_helpers.tpl @@ -0,0 +1,11 @@ +{{- define "name" -}}{{ .Release.Name }}{{- end }} +{{- define "agentname" -}}{{ .Values.agentName | default .Release.Name }}{{- end }} + +{{/* create a container image reference */}} +{{- define "image" -}} + {{- $default := (index . 0).Values.image -}} + {{- $this := (index . 1) -}} + + {{- $this.repository | default $default.repository -}}: + {{- $this.tag | default $default.tag -}} +{{- end }} diff --git a/charts/api-syncagent/templates/deployment.yaml b/charts/api-syncagent/templates/deployment.yaml new file mode 100644 index 0000000..e55b2fa --- /dev/null +++ b/charts/api-syncagent/templates/deployment.yaml @@ -0,0 +1,80 @@ +apiVersion: v1 +kind: ServiceAccount +metadata: + name: '{{ template "name" . }}' + labels: + app.kubernetes.io/name: kcp-sync-agent + app.kubernetes.io/instance: '{{ template "agentname" . }}' + +--- +apiVersion: apps/v1 +kind: Deployment +metadata: + name: '{{ template "name" . }}' +spec: + replicas: {{ .Values.replicas | default 1 }} + selector: + matchLabels: + app.kubernetes.io/name: kcp-sync-agent + app.kubernetes.io/instance: '{{ template "agentname" . }}' + template: + metadata: + labels: + app.kubernetes.io/name: kcp-sync-agent + app.kubernetes.io/instance: '{{ template "agentname" . }}' + app.kubernetes.io/version: '{{ .Values.image.tag | default .Chart.AppVersion }}' + spec: + containers: + - name: agent + args: + - --namespace=$(POD_NAMESPACE) + - --enable-leader-election + - --apiexport-ref=$(APIEXPORT_REF) + - --agent-name=$(AGENT_NAME) + - --platform-kubeconfig=/etc/api-syncagent/platform/kubeconfig + {{- with .Values.kubeconfig }} + - --kubeconfig=/etc/api-syncagent/cluster/kubeconfig + {{- end }} + {{- with .Values.publishedResourceSelector }} + - "--published-resource-selector={{ . }}" + {{- end }} + env: + - name: POD_NAMESPACE + valueFrom: + fieldRef: + apiVersion: v1 + fieldPath: metadata.namespace + - name: APIEXPORT_REF + value: '{{ required "APIExport name must be configured" .Values.apiExportName }}' + - name: AGENT_NAME + value: '{{ template "agentname" . }}' + image: '{{ template "image" (list $ .Values.image) }}' + resources: {{ .Values.resources | toYaml | nindent 12 }} + securityContext: + allowPrivilegeEscalation: false + capabilities: + drop: + - ALL + volumeMounts: + - name: platform-kubeconfig + mountPath: /etc/api-syncagent/platform + {{- with .Values.kubeconfig }} + - name: cluster-kubeconfig + mountPath: /etc/api-syncagent/cluster + {{- end }} + securityContext: + runAsNonRoot: true + runAsUser: 65534 + seccompProfile: + type: RuntimeDefault + serviceAccountName: '{{ template "name" . }}' + volumes: + - name: platform-kubeconfig + secret: + secretName: '{{ required "Kubernetes Secret for the platform kubeconfig must be configured" .Values.platformKubeconfig }}' + {{- with .Values.kubeconfig }} + - name: cluster-kubeconfig + secret: + secretName: "{{ . }}" + {{- end }} + diff --git a/charts/api-syncagent/templates/rbac.yaml b/charts/api-syncagent/templates/rbac.yaml new file mode 100644 index 0000000..7129ad5 --- /dev/null +++ b/charts/api-syncagent/templates/rbac.yaml @@ -0,0 +1,115 @@ +{{- if .Values.rbac.create }} +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: Role +metadata: + name: '{{ template "name" . }}:leaderelection' +rules: + - apiGroups: + - coordination.k8s.io + resources: + - leases + verbs: + - get + - list + - watch + - create + - update + - patch + - delete + - apiGroups: + - "" + resources: + - events + verbs: + - create + - patch + +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: RoleBinding +metadata: + name: '{{ template "name" . }}:leaderelection' +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: Role + name: '{{ template "name" . }}:leaderelection' +subjects: + - kind: ServiceAccount + name: '{{ template "name" . }}' + +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + name: '{{ template "name" . }}:{{ .Release.Namespace }}:services' + namespace: kdp +rules: + - apiGroups: + - "" + resources: + - secrets + verbs: + - get + - list + - watch + - create + - update + - apiGroups: + - services.syncagent.kcp.io + resources: + - publishedresources + verbs: + - get + - list + - watch + - apiGroups: + - services.syncagent.kcp.io + resources: + - publishedresources/status + verbs: + - create + - get + - update + - patch + +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRoleBinding +metadata: + name: '{{ template "name" . }}:{{ .Release.Namespace }}:services' + namespace: kdp +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: ClusterRole + name: '{{ template "name" . }}:{{ .Release.Namespace }}:services' +subjects: + - kind: ServiceAccount + name: '{{ template "name" . }}' + namespace: '{{ .Release.Namespace }}' +{{- end }} + +{{ if .Values.rbac.createClusterRole }} +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + name: '{{ template "name" . }}:{{ .Release.Namespace }}' + namespace: kdp +rules: {{ .Values.rbac.rules | toYaml | nindent 2 }} + +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRoleBinding +metadata: + name: '{{ template "name" . }}:{{ .Release.Namespace }}' + namespace: kdp +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: ClusterRole + name: '{{ template "name" . }}:{{ .Release.Namespace }}' +subjects: + - kind: ServiceAccount + name: '{{ template "name" . }}' + namespace: '{{ .Release.Namespace }}' +{{ end }} diff --git a/charts/api-syncagent/values.yaml b/charts/api-syncagent/values.yaml new file mode 100644 index 0000000..349db41 --- /dev/null +++ b/charts/api-syncagent/values.yaml @@ -0,0 +1,47 @@ +# Required: the name of the APIExport in kcp that this Sync Agent is supposed to serve. +apiExportName: "" + +# This Agent's public name, purely for informational purposes. If not set, defaults +# to the Helm release name. +agentName: "" + +# Required: Name of the Kubernetes Secret that contains a "kubeconfig" key, +# with the kubeconfig provided by kcp to access it. +platformKubeconfig: "" + +# Optional: Name of a Kubernetes Secret that contains a "kubeconfig" key, +# with a kubeconfig to access the service cluster (in case the agent is +# running on a cluster that is not the target cluster for the API sync). +kubeconfig: "" + +# Optional: If two or more SyncAgents are installed into the same namespace, +# each one must have a Kubernetes label selector to scope down which +# PublishedResources (PRs) they process, as no two agents must process the same. +# If just one Sync Agent is installed in the cluster, this can be left blank, but +# still be used to ignore certain PRs if desired. +publishedResourceSelector: "" + +# The container image to use for the Sync Agent. +image: + repository: "ghcr.io/kcp-dev/api-syncagent" + # set this to override the image tag used (determined by chart appVersion by default). + tag: "" + +replicas: 2 + +rbac: + # When set to false, no RBAC will be created. + create: true + # When set to true, will create a ClusterRole named ":" + # and assign it the configured rules; use this to provide additional permissions + # for the Sync Agent. + createClusterRole: false + rules: [] + +resources: + requests: + cpu: 100m + memory: 64Mi + limits: + cpu: 1 + memory: 512Mi From 0b29fd93e9c4db04f81b085407a162f9df2cdb54 Mon Sep 17 00:00:00 2001 From: Christoph Mewes Date: Thu, 9 Jan 2025 21:11:13 +0100 Subject: [PATCH 2/7] update CI scripting On-behalf-of: @SAP christoph.mewes@sap.com --- hack/ci/render-helm-charts.sh | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/hack/ci/render-helm-charts.sh b/hack/ci/render-helm-charts.sh index 01d1964..f35d859 100755 --- a/hack/ci/render-helm-charts.sh +++ b/hack/ci/render-helm-charts.sh @@ -5,13 +5,13 @@ set -euo pipefail cd "$(dirname "$0")/../.." if ! [ -x "$(command -v helm)" ]; then - echo "missing helm command in PATH" - exit 1 + echo "missing helm command in PATH" + exit 1 fi if ! [ -x "$(command -v kubeconform)" ]; then - echo "missing kubeconform command in PATH" - exit 1 + echo "missing kubeconform command in PATH" + exit 1 fi for dir in ./charts/*/; do @@ -21,6 +21,8 @@ for dir in ./charts/*/; do helm template \ --debug \ --set=externalHostname=ci.kcp.io \ + --set=apiExportName=my-api \ + --set=platformKubeconfig=kcp-kubeconfig \ kcp ./charts/${chart}/ | tee ${chart}-templated.yaml echo "---" From f5a4c4893b967c055ef9ae5b508a9e6c1d8780d8 Mon Sep 17 00:00:00 2001 From: Christoph Mewes Date: Fri, 10 Jan 2025 12:19:12 +0100 Subject: [PATCH 3/7] remove dedicated options to define RBAC This offered no real benefit over someone simply having their own rbac.yaml. Adding this as an option to the chart just means we have to continue to support it, and why would we then only support defining custom RBAC and not even other resources? At that point we would become a meta-meta Helm chart and that's just not worth it. On-behalf-of: @SAP christoph.mewes@sap.com --- .../api-syncagent/templates/deployment.yaml | 6 +-- charts/api-syncagent/templates/rbac.yaml | 49 +------------------ charts/api-syncagent/values.yaml | 9 ---- 3 files changed, 4 insertions(+), 60 deletions(-) diff --git a/charts/api-syncagent/templates/deployment.yaml b/charts/api-syncagent/templates/deployment.yaml index e55b2fa..cd8db21 100644 --- a/charts/api-syncagent/templates/deployment.yaml +++ b/charts/api-syncagent/templates/deployment.yaml @@ -3,7 +3,7 @@ kind: ServiceAccount metadata: name: '{{ template "name" . }}' labels: - app.kubernetes.io/name: kcp-sync-agent + app.kubernetes.io/name: kcp-api-syncagent app.kubernetes.io/instance: '{{ template "agentname" . }}' --- @@ -15,12 +15,12 @@ spec: replicas: {{ .Values.replicas | default 1 }} selector: matchLabels: - app.kubernetes.io/name: kcp-sync-agent + app.kubernetes.io/name: kcp-api-syncagent app.kubernetes.io/instance: '{{ template "agentname" . }}' template: metadata: labels: - app.kubernetes.io/name: kcp-sync-agent + app.kubernetes.io/name: kcp-api-syncagent app.kubernetes.io/instance: '{{ template "agentname" . }}' app.kubernetes.io/version: '{{ .Values.image.tag | default .Chart.AppVersion }}' spec: diff --git a/charts/api-syncagent/templates/rbac.yaml b/charts/api-syncagent/templates/rbac.yaml index 7129ad5..c12b95f 100644 --- a/charts/api-syncagent/templates/rbac.yaml +++ b/charts/api-syncagent/templates/rbac.yaml @@ -1,5 +1,3 @@ -{{- if .Values.rbac.create }} ---- apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: @@ -42,8 +40,7 @@ subjects: apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: - name: '{{ template "name" . }}:{{ .Release.Namespace }}:services' - namespace: kdp + name: '{{ template "name" . }}:{{ .Release.Namespace }}' rules: - apiGroups: - "" @@ -55,55 +52,12 @@ rules: - watch - create - update - - apiGroups: - - services.syncagent.kcp.io - resources: - - publishedresources - verbs: - - get - - list - - watch - - apiGroups: - - services.syncagent.kcp.io - resources: - - publishedresources/status - verbs: - - create - - get - - update - - patch - ---- -apiVersion: rbac.authorization.k8s.io/v1 -kind: ClusterRoleBinding -metadata: - name: '{{ template "name" . }}:{{ .Release.Namespace }}:services' - namespace: kdp -roleRef: - apiGroup: rbac.authorization.k8s.io - kind: ClusterRole - name: '{{ template "name" . }}:{{ .Release.Namespace }}:services' -subjects: - - kind: ServiceAccount - name: '{{ template "name" . }}' - namespace: '{{ .Release.Namespace }}' -{{- end }} - -{{ if .Values.rbac.createClusterRole }} ---- -apiVersion: rbac.authorization.k8s.io/v1 -kind: ClusterRole -metadata: - name: '{{ template "name" . }}:{{ .Release.Namespace }}' - namespace: kdp -rules: {{ .Values.rbac.rules | toYaml | nindent 2 }} --- apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: '{{ template "name" . }}:{{ .Release.Namespace }}' - namespace: kdp roleRef: apiGroup: rbac.authorization.k8s.io kind: ClusterRole @@ -112,4 +66,3 @@ subjects: - kind: ServiceAccount name: '{{ template "name" . }}' namespace: '{{ .Release.Namespace }}' -{{ end }} diff --git a/charts/api-syncagent/values.yaml b/charts/api-syncagent/values.yaml index 349db41..5fdd530 100644 --- a/charts/api-syncagent/values.yaml +++ b/charts/api-syncagent/values.yaml @@ -29,15 +29,6 @@ image: replicas: 2 -rbac: - # When set to false, no RBAC will be created. - create: true - # When set to true, will create a ClusterRole named ":" - # and assign it the configured rules; use this to provide additional permissions - # for the Sync Agent. - createClusterRole: false - rules: [] - resources: requests: cpu: 100m From 15a489234f1e7c395a9a04957a2645cf8e0fff91 Mon Sep 17 00:00:00 2001 From: Christoph Mewes Date: Mon, 13 Jan 2025 19:10:47 +0100 Subject: [PATCH 4/7] fix missing permissions On-behalf-of: @SAP christoph.mewes@sap.com --- charts/api-syncagent/templates/rbac.yaml | 34 ++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/charts/api-syncagent/templates/rbac.yaml b/charts/api-syncagent/templates/rbac.yaml index c12b95f..3e80311 100644 --- a/charts/api-syncagent/templates/rbac.yaml +++ b/charts/api-syncagent/templates/rbac.yaml @@ -52,6 +52,40 @@ rules: - watch - create - update + - apiGroups: + - "" + resources: + - namespaces + verbs: + - get + - list + - watch + - create + - apiGroups: + - apiextensions.k8s.io + resources: + - customresourcedefinitions + verbs: + - get + - list + - watch + - apiGroups: + - syncagent.kcp.io + resources: + - publishedresources + verbs: + - get + - list + - watch + - apiGroups: + - syncagent.kcp.io + resources: + - publishedresources/status + verbs: + - create + - get + - update + - patch --- apiVersion: rbac.authorization.k8s.io/v1 From 2aeb1161390a1ffa7abced927db5d585273312fd Mon Sep 17 00:00:00 2001 From: Christoph Mewes Date: Mon, 13 Jan 2025 19:11:00 +0100 Subject: [PATCH 5/7] allow to disable leader election On-behalf-of: @SAP christoph.mewes@sap.com --- charts/api-syncagent/templates/deployment.yaml | 2 +- charts/api-syncagent/values.yaml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/charts/api-syncagent/templates/deployment.yaml b/charts/api-syncagent/templates/deployment.yaml index cd8db21..e3864df 100644 --- a/charts/api-syncagent/templates/deployment.yaml +++ b/charts/api-syncagent/templates/deployment.yaml @@ -28,7 +28,7 @@ spec: - name: agent args: - --namespace=$(POD_NAMESPACE) - - --enable-leader-election + - --enable-leader-election={{ .Values.enableLeaderElection }} - --apiexport-ref=$(APIEXPORT_REF) - --agent-name=$(AGENT_NAME) - --platform-kubeconfig=/etc/api-syncagent/platform/kubeconfig diff --git a/charts/api-syncagent/values.yaml b/charts/api-syncagent/values.yaml index 5fdd530..2d062f1 100644 --- a/charts/api-syncagent/values.yaml +++ b/charts/api-syncagent/values.yaml @@ -28,6 +28,7 @@ image: tag: "" replicas: 2 +enableLeaderElection: true resources: requests: From 89ecc41ad45c2fb2107164391aecdbded319ca08 Mon Sep 17 00:00:00 2001 From: Christoph Mewes Date: Mon, 13 Jan 2025 19:28:15 +0100 Subject: [PATCH 6/7] follow kcp-dev/api-syncagent#8, rename platform to kcp On-behalf-of: @SAP christoph.mewes@sap.com --- charts/api-syncagent/templates/deployment.yaml | 11 +++++------ charts/api-syncagent/values.yaml | 2 +- hack/ci/render-helm-charts.sh | 2 +- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/charts/api-syncagent/templates/deployment.yaml b/charts/api-syncagent/templates/deployment.yaml index e3864df..6e01964 100644 --- a/charts/api-syncagent/templates/deployment.yaml +++ b/charts/api-syncagent/templates/deployment.yaml @@ -31,7 +31,7 @@ spec: - --enable-leader-election={{ .Values.enableLeaderElection }} - --apiexport-ref=$(APIEXPORT_REF) - --agent-name=$(AGENT_NAME) - - --platform-kubeconfig=/etc/api-syncagent/platform/kubeconfig + - --kcp-kubeconfig=/etc/api-syncagent/kcp/kubeconfig {{- with .Values.kubeconfig }} - --kubeconfig=/etc/api-syncagent/cluster/kubeconfig {{- end }} @@ -56,8 +56,8 @@ spec: drop: - ALL volumeMounts: - - name: platform-kubeconfig - mountPath: /etc/api-syncagent/platform + - name: kcp-kubeconfig + mountPath: /etc/api-syncagent/kcp {{- with .Values.kubeconfig }} - name: cluster-kubeconfig mountPath: /etc/api-syncagent/cluster @@ -69,12 +69,11 @@ spec: type: RuntimeDefault serviceAccountName: '{{ template "name" . }}' volumes: - - name: platform-kubeconfig + - name: kcp-kubeconfig secret: - secretName: '{{ required "Kubernetes Secret for the platform kubeconfig must be configured" .Values.platformKubeconfig }}' + secretName: '{{ required "Kubernetes Secret for the kcp kubeconfig must be configured" .Values.kcpKubeconfig }}' {{- with .Values.kubeconfig }} - name: cluster-kubeconfig secret: secretName: "{{ . }}" {{- end }} - diff --git a/charts/api-syncagent/values.yaml b/charts/api-syncagent/values.yaml index 2d062f1..94d0612 100644 --- a/charts/api-syncagent/values.yaml +++ b/charts/api-syncagent/values.yaml @@ -7,7 +7,7 @@ agentName: "" # Required: Name of the Kubernetes Secret that contains a "kubeconfig" key, # with the kubeconfig provided by kcp to access it. -platformKubeconfig: "" +kcpKubeconfig: "" # Optional: Name of a Kubernetes Secret that contains a "kubeconfig" key, # with a kubeconfig to access the service cluster (in case the agent is diff --git a/hack/ci/render-helm-charts.sh b/hack/ci/render-helm-charts.sh index f35d859..38c7b75 100755 --- a/hack/ci/render-helm-charts.sh +++ b/hack/ci/render-helm-charts.sh @@ -22,7 +22,7 @@ for dir in ./charts/*/; do --debug \ --set=externalHostname=ci.kcp.io \ --set=apiExportName=my-api \ - --set=platformKubeconfig=kcp-kubeconfig \ + --set=kcpKubeconfig=kcp-kubeconfig \ kcp ./charts/${chart}/ | tee ${chart}-templated.yaml echo "---" From 67af021dfc47b7dbb474e4a9217493f8b989f6a5 Mon Sep 17 00:00:00 2001 From: Christoph Mewes Date: Mon, 13 Jan 2025 19:31:55 +0100 Subject: [PATCH 7/7] add support for kcp-dev/api-syncagent#6 On-behalf-of: @SAP christoph.mewes@sap.com --- charts/api-syncagent/templates/deployment.yaml | 6 ++++++ charts/api-syncagent/values.yaml | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/charts/api-syncagent/templates/deployment.yaml b/charts/api-syncagent/templates/deployment.yaml index 6e01964..8540cf8 100644 --- a/charts/api-syncagent/templates/deployment.yaml +++ b/charts/api-syncagent/templates/deployment.yaml @@ -35,6 +35,12 @@ spec: {{- with .Values.kubeconfig }} - --kubeconfig=/etc/api-syncagent/cluster/kubeconfig {{- end }} + {{- with .Values.kubeconfigHostOverride }} + - "--kubeconfig-host-override={{ . }}" + {{- end }} + {{- with .Values.kubeconfigCAFileOverride }} + - "--kubeconfig-ca-file-override={{ . }}" + {{- end }} {{- with .Values.publishedResourceSelector }} - "--published-resource-selector={{ . }}" {{- end }} diff --git a/charts/api-syncagent/values.yaml b/charts/api-syncagent/values.yaml index 94d0612..55f1643 100644 --- a/charts/api-syncagent/values.yaml +++ b/charts/api-syncagent/values.yaml @@ -14,6 +14,12 @@ kcpKubeconfig: "" # running on a cluster that is not the target cluster for the API sync). kubeconfig: "" +# Optional: Override the host configured in the local kubeconfig. +kubeconfigHostOverride: "" + +# Optional: Override the server CA file configured in the local kubeconfig +kubeconfigCAFileOverride: "" + # Optional: If two or more SyncAgents are installed into the same namespace, # each one must have a Kubernetes label selector to scope down which # PublishedResources (PRs) they process, as no two agents must process the same.