diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..120c689 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" \ No newline at end of file diff --git a/.github/workflows/helm-chart-publish.yaml b/.github/workflows/helm-chart-publish.yaml new file mode 100644 index 0000000..80b84e3 --- /dev/null +++ b/.github/workflows/helm-chart-publish.yaml @@ -0,0 +1,58 @@ +name: Release Charts + +on: + push: + branches: + - main + paths: + - "charts/**" + + +jobs: + release: + runs-on: ubuntu-latest + + permissions: + contents: write + packages: write + id-token: write + + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Configure Git + run: | + git config user.name "$GITHUB_ACTOR" + git config user.email "$GITHUB_ACTOR@users.noreply.github.com" + + - name: Run chart-releaser + uses: helm/chart-releaser-action@3e001cb8c68933439c7e721650f20a07a1a5c61e # pin@v1.6.0 + with: + config: cr.yaml + env: + CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" + + - name: Login to GitHub Container Registry + uses: docker/login-action@327cd5a69de6c009b9ce71bce8395f28e651bf99 #pin@v3.3.0 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Install Cosign + uses: sigstore/cosign-installer@c56c2d3e59e4281cc41dea2217323ba5694b171e #pin@v3.7.0 + + - name: Publish and Sign OCI Charts + run: | + for chart in `find .cr-release-packages -name '*.tgz' -print`; do + helm push ${chart} oci://ghcr.io/${GITHUB_REPOSITORY} |& tee helm-push-output.log + file_name=${chart##*/} + chart_name=${file_name%-*} + digest=$(awk -F "[, ]+" '/Digest/{print $NF}' < helm-push-output.log) + cosign sign -y "ghcr.io/${GITHUB_REPOSITORY}/${chart_name}@${digest}" + done + env: + COSIGN_EXPERIMENTAL: 1 \ No newline at end of file diff --git a/.github/workflows/helm-chart-test.yaml b/.github/workflows/helm-chart-test.yaml new file mode 100644 index 0000000..ec4eeb4 --- /dev/null +++ b/.github/workflows/helm-chart-test.yaml @@ -0,0 +1,50 @@ +name: Test Charts + +on: + pull_request: + paths: + - charts/** + +jobs: + check-readme: + runs-on: ubuntu-latest + env: + GO111MODULE: on + steps: + - name: Checkout + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + + - uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5 + with: + python-version: '3.x' + + - uses: actions/setup-go@5a083d0e9a84784eb32078397cf5459adecb4c40 # pin@v3 + with: + go-version: ^1 + + test: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + with: + fetch-depth: 0 + + - name: Set up Helm + uses: azure/setup-helm@fe7b79cd5ee1e45176fcad797de68ecaf3ca4814 # pin@v4.2.0 + + - uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5 + with: + python-version: '3.x' + + - name: Set up chart-testing + uses: helm/chart-testing-action@v2.7.0 + + - name: Run chart-testing (lint) + run: ct lint --config ct.yaml + + - name: Create KIND Cluster + uses: helm/kind-action@a1b0e391336a6ee6713a0583f8c6240d70863de3 # pin@v1.12.0 + + - name: Run chart-testing (install) + run: ct install --config ct.yaml \ No newline at end of file diff --git a/charts/codegate/.helmignore b/charts/codegate/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/codegate/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/charts/codegate/Chart.yaml b/charts/codegate/Chart.yaml new file mode 100644 index 0000000..171c7ce --- /dev/null +++ b/charts/codegate/Chart.yaml @@ -0,0 +1,6 @@ +apiVersion: v2 +name: codegate +description: A Helm chart for deploying Codegate onto Kubernetes +type: application +version: 0.0.1 +appVersion: "v0.1.22" diff --git a/charts/codegate/README.md b/charts/codegate/README.md new file mode 100644 index 0000000..ea37008 --- /dev/null +++ b/charts/codegate/README.md @@ -0,0 +1,50 @@ +# Codegate + +![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.1.22](https://img.shields.io/badge/AppVersion-2.112.0-informational?style=flat-square) + +CodeGate is a local gateway that makes AI agents and coding assistants safer. + +## TL;DR + +```console +helm repo add codegate [] + +helm install codegate/codegate +``` + +## Usage + +The Codegate Chart is available in the following formats: +- [Chart Repository](https://helm.sh/docs/topics/chart_repository/) +- [OCI Artifacts](https://helm.sh/docs/topics/registries/) + +### Installing from Chart Repository + +The following command can be used to add the chart repository: + +```console +helm repo add codegate [] +``` + +Once the chart has been added, install one of the available charts: + +```console +helm install codegate/codegate +``` + +### Installing from an OCI Registry + +Charts are also available in OCI format. The list of available charts can be found [here](https://github.com/stacklok/codegate-helm/charts). +Install one of the available charts: + +```shell +helm upgrade -i oci://ghcr.io/stacklok/codegate-helm/codegate --version= +``` + +## Source Code + +* + +## Values + + diff --git a/charts/codegate/ci/default-values.yaml b/charts/codegate/ci/default-values.yaml new file mode 100644 index 0000000..0ded8b7 --- /dev/null +++ b/charts/codegate/ci/default-values.yaml @@ -0,0 +1,2 @@ +volumePersistence: + storageClassName: standard diff --git a/charts/codegate/templates/_helpers.tpl b/charts/codegate/templates/_helpers.tpl new file mode 100644 index 0000000..757dbca --- /dev/null +++ b/charts/codegate/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "codegate.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "codegate.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "codegate.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "codegate.labels" -}} +helm.sh/chart: {{ include "codegate.chart" . }} +{{ include "codegate.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "codegate.selectorLabels" -}} +app.kubernetes.io/name: {{ include "codegate.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "codegate.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "codegate.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/codegate/templates/deployment.yaml b/charts/codegate/templates/deployment.yaml new file mode 100644 index 0000000..6b3cd7a --- /dev/null +++ b/charts/codegate/templates/deployment.yaml @@ -0,0 +1,70 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "codegate.fullname" . }} + namespace: {{ .Release.Namespace | quote }} + labels: + {{- include "codegate.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + # we hardcode to 1 at the moment as there is only a single file sqlite database + replicas: 1 + {{- end }} + selector: + matchLabels: + {{- include "codegate.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "codegate.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "codegate.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag}}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: {{ .Values.service.port }} + protocol: TCP + livenessProbe: + {{- toYaml .Values.livenessProbe | nindent 12 }} + readinessProbe: + {{- toYaml .Values.readinessProbe | nindent 12 }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.volumeMounts }} + volumeMounts: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- with .Values.volumes }} + volumes: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/charts/codegate/templates/hpa.yaml b/charts/codegate/templates/hpa.yaml new file mode 100644 index 0000000..01bc451 --- /dev/null +++ b/charts/codegate/templates/hpa.yaml @@ -0,0 +1,33 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "codegate.fullname" . }} + namespace: {{ .Release.Namespace | quote }} + labels: + {{- include "codegate.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "codegate.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/charts/codegate/templates/ingress.yaml b/charts/codegate/templates/ingress.yaml new file mode 100644 index 0000000..1267c98 --- /dev/null +++ b/charts/codegate/templates/ingress.yaml @@ -0,0 +1,44 @@ +{{- if .Values.ingress.enabled -}} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ include "codegate.fullname" . }} + namespace: {{ .Release.Namespace | quote }} + labels: + {{- include "codegate.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- with .Values.ingress.className }} + ingressClassName: {{ . }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + {{- with .pathType }} + pathType: {{ . }} + {{- end }} + backend: + service: + name: {{ include "codegate.fullname" $ }} + port: + number: {{ $.Values.service.port }} + {{- end }} + {{- end }} +{{- end }} diff --git a/charts/codegate/templates/pvc.yaml b/charts/codegate/templates/pvc.yaml new file mode 100644 index 0000000..2e78518 --- /dev/null +++ b/charts/codegate/templates/pvc.yaml @@ -0,0 +1,15 @@ +{{- if .Values.volumePersistence.enabled }} +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: {{ .Values.volumePersistence.pvcName }} + namespace: {{ .Release.Namespace | quote }} +spec: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: {{ .Values.volumePersistence.resources.requests.storage }} + storageClassName: {{ .Values.volumePersistence.storageClassName }} + volumeMode: {{ .Values.volumePersistence.volumeMode }} +{{- end }} \ No newline at end of file diff --git a/charts/codegate/templates/service.yaml b/charts/codegate/templates/service.yaml new file mode 100644 index 0000000..6ac81de --- /dev/null +++ b/charts/codegate/templates/service.yaml @@ -0,0 +1,19 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "codegate.fullname" . }} + namespace: {{ .Release.Namespace | quote }} + labels: + {{- include "codegate.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: {{ .Values.service.port }} + protocol: TCP + name: http-api + {{- with .Values.extraServicePorts }} + {{- toYaml . | nindent 6 }} + {{- end }} + selector: + {{- include "codegate.selectorLabels" . | nindent 4 }} diff --git a/charts/codegate/templates/serviceaccount.yaml b/charts/codegate/templates/serviceaccount.yaml new file mode 100644 index 0000000..0e5adea --- /dev/null +++ b/charts/codegate/templates/serviceaccount.yaml @@ -0,0 +1,14 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "codegate.serviceAccountName" . }} + namespace: {{ .Release.Namespace | quote }} + labels: + {{- include "codegate.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} diff --git a/charts/codegate/values.yaml b/charts/codegate/values.yaml new file mode 100644 index 0000000..013fe50 --- /dev/null +++ b/charts/codegate/values.yaml @@ -0,0 +1,140 @@ +# This is to override the chart name. +nameOverride: "" +fullnameOverride: "" + +# This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/ +image: + repository: ghcr.io/stacklok/codegate + # This sets the pull policy for images. + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "v0.1.22" + +# This is for the secretes for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ +imagePullSecrets: [] + +# This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ +replicaCount: 1 + +# This section builds out the service account more information can be found here: https://kubernetes.io/docs/concepts/security/service-accounts/ +serviceAccount: + # Specifies whether a service account should be created + create: true + # Automatically mount a ServiceAccount's API credentials? + automount: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "codegate" + +# This is for setting Kubernetes Annotations to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ +podAnnotations: {} +# This is for setting Kubernetes Labels to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +podLabels: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +# This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/ +service: + # This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + type: ClusterIP + # This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports + port: 8989 + + extraServicePorts: + - port: 9090 + targetPort: 9090 + protocol: TCP + name: http-dashboard + - port: 8990 + targetPort: 8990 + protocol: TCP + name: http-copilot-proxy + +# This block is for setting up the ingress for more information can be found here: https://kubernetes.io/docs/concepts/services-networking/ingress/ +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +# This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ +livenessProbe: + httpGet: + path: /health + port: http +readinessProbe: + httpGet: + path: /health + port: http + +# This section is for setting up autoscaling more information can be found here: https://kubernetes.io/docs/concepts/workloads/autoscaling/ +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +# Additional volumes on the output Deployment definition. +volumes: +- name: codegate-volume + persistentVolumeClaim: + claimName: codegate-0 + +# Additional volumeMounts on the output Deployment definition. +volumeMounts: +- mountPath: /app/codegate-volume + name: codegate-volume + +# Creates a PVC for a PV volume for persisting codegate data +# Only 1 PV will be created because codegate is not a statefulset +volumePersistence: + enabled: true + pvcName: codegate-0 + resources: + requests: + storage: 10Gi + storageClassName: gp2 + volumeMode: Filesystem + + +nodeSelector: {} + +tolerations: [] + +affinity: {} diff --git a/cr.yaml b/cr.yaml new file mode 100644 index 0000000..466d51e --- /dev/null +++ b/cr.yaml @@ -0,0 +1,2 @@ +generate-release-notes: true +charts_dir: charts \ No newline at end of file diff --git a/ct.yaml b/ct.yaml new file mode 100644 index 0000000..07c252b --- /dev/null +++ b/ct.yaml @@ -0,0 +1,5 @@ +chart-dirs: + - charts +validate-maintainers: false +remote: origin +target-branch: main \ No newline at end of file