Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add podLabels podAnnotations to Helm Charts #8712

Merged
merged 10 commits into from
Apr 17, 2024
Merged

Add podLabels podAnnotations to Helm Charts #8712

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ced9554
[helm] add nodeSelector
yashgorana Apr 16, 2024
b702037
[helm] add podLabels & podAnnotations
yashgorana Apr 16, 2024
c417c45
[helm] update resource limits
yashgorana Apr 16, 2024
a8154f8
[helm] add profiles to devspace
yashgorana Apr 16, 2024
a7efc49
[devspace] remove dev tag
yashgorana Apr 17, 2024
253aed9
Merge branch 'dev' into yash/helm-node-selector
yashgorana Apr 17, 2024
4d5deca
fix insufficient CPU in CI
yashgorana Apr 17, 2024
c06911a
fix wait_for seaweedfs
yashgorana Apr 17, 2024
78d5477
fix incorrect node type
yashgorana Apr 17, 2024
4ce5368
Merge branch 'dev' into yash/helm-node-selector
yashgorana Apr 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,6 @@ nohup.out

# notebook data
notebooks/helm/scenario_data.jsonl

# tox syft.build.helm generated file
out.txt
out.*
28 changes: 24 additions & 4 deletions packages/grid/devspace.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@ pipelines:
create_deployments --all

vars:
DEVSPACE_ENV_FILE: "default.env"
DOCKER_IMAGE_BACKEND: openmined/grid-backend
DOCKER_IMAGE_FRONTEND: openmined/grid-frontend
DOCKER_IMAGE_SEAWEEDFS: openmined/grid-seaweedfs
CONTAINER_REGISTRY: "docker.io"
NODE_NAME: "mynode"
VERSION: "0.8.7-beta.1"
PLATFORM: $(uname -m | grep -q 'arm64' && echo "arm64" || echo "amd64")

Expand Down Expand Up @@ -67,8 +68,6 @@ deployments:
global:
registry: ${CONTAINER_REGISTRY}
version: dev-${DEVSPACE_TIMESTAMP}
node:
name: ${NODE_NAME}
# anything that does not need devspace $env vars should go in values.dev.yaml
valuesFiles:
- ./helm/values.dev.yaml
Expand Down Expand Up @@ -117,3 +116,24 @@ profiles:
path: images.seaweedfs
- op: remove
path: dev.seaweedfs

- name: gcp
patches:
- op: replace
path: deployments.syft.helm.valuesFiles
value:
- ./helm/examples/gcp/gcp.high.yaml

- name: gcp-low
patches:
- op: replace
path: deployments.syft.helm.valuesFiles
value:
- ./helm/examples/gcp/gcp.low.yaml

- name: azure
patches:
- op: replace
path: deployments.syft.helm.valuesFiles
value:
- ./helm/examples/azure/azure.high.yaml
34 changes: 34 additions & 0 deletions packages/grid/helm/examples/azure/azure.high.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# ===================================================
# Deploy Syft High Side Node to an AKS Cluster
# DOES NOT sync seaweedfs to a Azure bucket
# ===================================================

node:
name: syft-azure
side: high
rootEmail: info@openmined.org
defaultWorkerPoolCount: 1
resourcesPreset: 2xlarge

ingress:
# Make sure cluster is created with --enable-app-routing
# az aks create -g group-name -n cluster-name -l region --enable-app-routing
className: webapprouting.kubernetes.azure.com
# or, has azure-application-gateway setup through dashboard or CLI
# className: azure-application-gateway


seaweedfs:
resourcesPreset: 2xlarge

proxy:
resourcesPreset: medium

registry:
resourcesPreset: medium

frontend:
resourcesPreset: medium

mongo:
resourcesPreset: large
41 changes: 41 additions & 0 deletions packages/grid/helm/examples/gcp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# GCS Deployment

## Resource Links
* [Autopilot Overview](https://cloud.google.com/kubernetes-engine/docs/concepts/autopilot-overview)
* [Autopilot Resource Limits Defaults](https://cloud.google.com/kubernetes-engine/docs/concepts/autopilot-resource-requests#compute-class-defaults)
* [AutoPilot Resource Limits Min/Max](https://cloud.google.com/kubernetes-engine/docs/concepts/autopilot-resource-requests#min-max-requests)
* [Compute Classes](https://cloud.google.com/kubernetes-engine/docs/concepts/autopilot-compute-classes)
* [Performance Pods](https://cloud.google.com/kubernetes-engine/docs/how-to/performance-pods)

## Setup

Helm `values.yaml` for high & low side deployments
- [`gcp.high.yaml`](./gcp.high.yaml)
- [`gcp.low.yaml`](./gcp.low.yaml)

Deployment on GKE with SeaweedFS sync to GCS requires:
1. A GCS bucket in the same project where the cluster will be deployed
* `syft-bucket-high` (for high side deployment)
* `syft-bucket-low` (for low side deployment)

2. An IAM service account with sufficient permissions to read/write/delete object to these buckets

## For Autopilot Cluster

Uncomment the `nodeSelector` to use a specific compute class + machine family.

Set resource limits in-line with the machine family

```yaml
nodeSelector:
cloud.google.com/compute-class: Performance
cloud.google.com/machine-family: c3

resources:
requests:
cpu: 2
memory: "8Gi"
limits:
cpu: 4
memory: "16Gi"
```
81 changes: 81 additions & 0 deletions packages/grid/helm/examples/gcp/gcp.high.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# ===================================================
# Deploy Syft High Side Node to a GKE Cluster
# Syncs seaweedfs to a GCS bucket "syft-bucket-high"
# ===================================================

node:
name: syft-gcp
side: high

# Force backend to write results to this bucket
# should be same as mountApi.mounts.local_bucket
defaultBucketName: syft-bucket-high-gcs

# For autopilot clusters with GKE 1.28+, uncomment this
# nodeSelector:
# cloud.google.com/compute-class: Performance
# cloud.google.com/machine-family: c3

# Resources set inline with c3-standard-4 machine type
resources:
requests:
cpu: 2
memory: "8Gi"
limits:
cpu: 4
memory: "16Gi"

seaweedfs:
storageSize: 100Gi

mountApi:
# Mount remote GCS bucket named "syft-bucket-high" to seaweedfs bucket named "syft-bucket-high-gcs
mounts:
- local_bucket: syft-bucket-high-gcs
remote_bucket:
type: gcs
bucket_name: syft-bucket-high
# filename should be as secret.mountCredentials.name
# directory will always be /run/secrets/
creds: /run/secrets/gcs_creds.json

secret:
mountCredentials:
# remove this comment and paste the Service Account JSON Here
# TODO: move to workload identity
- name: gcs_creds.json
value: |
{
"": ""
}

# For autopilot clusters with GKE 1.28+, uncomment this
# nodeSelector:
# cloud.google.com/compute-class: Performance
# cloud.google.com/machine-family: c3

# Resources set inline with c3-standard-4 machine type
resources:
requests:
cpu: 2
memory: "8Gi"
limits:
cpu: 4
memory: "16Gi"

ingress:
# GKE 1.28+ need ingressClassName
className: gce
class: gce

proxy:
resourcesPreset: medium

registry:
resourcesPreset: medium

frontend:
resourcesPreset: medium

mongo:
resourcesPreset: large
82 changes: 82 additions & 0 deletions packages/grid/helm/examples/gcp/gcp.low.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# ===================================================
# Deploy Syft Low Side Node to a GKE Cluster
# Syncs seaweedfs to a GCS bucket "syft-bucket-low"
# ===================================================

node:
name: syft-gcp
side: low

# Force backend to write results to this bucket
# should be same as mountApi.mounts.local_bucket
defaultBucketName: syft-bucket-low-gcs

# For autopilot clusters with GKE 1.28+, uncomment this
# nodeSelector:
# cloud.google.com/compute-class: Performance
# cloud.google.com/machine-family: c3

# Resources set inline with c3-standard-4 machine type
resources:
requests:
cpu: 2
memory: "8Gi"
limits:
cpu: 4
memory: "16Gi"

seaweedfs:
storageSize: 100Gi

mountApi:
# Mount remote GCS bucket named "syft-bucket-low" to seaweedfs bucket named "syft-bucket-low-gcs
mounts:
- local_bucket: syft-bucket-low-gcs
remote_bucket:
type: gcs
bucket_name: syft-bucket-low
# filename should be as secret.mountCredentials.name
# directory will always be /run/secrets/
creds: /run/secrets/gcs_creds.json

secret:
mountCredentials:
# remove this comment and paste the Service Account JSON Here
# TODO: move to workload identity
- name: gcs_creds.json
value: |
{
"": ""
}

# For autopilot clusters with GKE 1.28+, uncomment this
# nodeSelector:
# cloud.google.com/compute-class: Performance
# cloud.google.com/machine-family: c3

# Resources set inline with c3-standard-4 machine type
resources:
requests:
cpu: 2
memory: "8Gi"
limits:
cpu: 4
memory: "16Gi"

ingress:
# GKE 1.28+ need ingressClassName
className: gce
class: gce

proxy:
resourcesPreset: medium

registry:
resourcesPreset: medium
storageSize: 50Gi

frontend:
resourcesPreset: medium

mongo:
resourcesPreset: large
47 changes: 47 additions & 0 deletions packages/grid/helm/examples/gcp/gcp.nosync.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# ===================================================
# Deploy Syft High Side Node to a GKE Cluster
# DOES NOT sync seaweedfs to a GCS bucket
# ===================================================

node:
name: syft-gcp
side: high

# Resources set inline with c3-standard-4 machine type
resources:
requests:
cpu: 2
memory: "8Gi"
limits:
cpu: 4
memory: "16Gi"

seaweedfs:
storageSize: 100Gi

# Resources set inline with c3-standard-4 machine type
resources:
requests:
cpu: 2
memory: "8Gi"
limits:
cpu: 4
memory: "16Gi"

ingress:
# GKE 1.28+ need ingressClassName
className: gce
class: gce

proxy:
resourcesPreset: medium

registry:
resourcesPreset: medium
storageSize: 100Gi

frontend:
resourcesPreset: medium

mongo:
resourcesPreset: large
13 changes: 10 additions & 3 deletions packages/grid/helm/syft/templates/backend/backend-statefulset.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,16 @@ spec:
labels:
{{- include "common.labels" . | nindent 8 }}
app.kubernetes.io/component: backend
{{- if .Values.node.podLabels }}
{{- toYaml .Values.node.podLabels | nindent 8 }}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we input mutiple podsLabels , it takes the last one.

Example Values files

node:
    podLabels:
        test/label: 5
        test/label: 2

Output

Screenshot 2024-04-17 at 3 00 27 PM

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But if I reverse the order
Screenshot 2024-04-17 at 3 01 58 PM

It takes the last one

Screenshot 2024-04-17 at 3 02 19 PM

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should take into account all the pod labels?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is valid & expected. metadata.labels & metadata.annotations are a map and not list. Both kubernetes and golang templating will hold only one value because underlying struct is a go map. You also see a squigly error line under your YAML because that's validation failure 😉

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh ok, is there a way such that a user could provide multiple pod annotations to pod spec by helm values?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it is supported and this change implements it (example), but k8s spec has explicit directives for the type of values the labels and annotations must have. Since keys-values must be strings, often times k8s providers will expect a JSON string as values (GKE example)

{{- end }}
{{- if .Values.node.podAnnotations }}
annotations: {{- toYaml .Values.node.podAnnotations | nindent 8 }}
{{- end }}
spec:
{{- if .Values.node.nodeSelector }}
nodeSelector: {{- .Values.node.nodeSelector | toYaml | nindent 8 }}
{{- end }}
containers:
- name: backend-container
image: {{ .Values.global.registry }}/openmined/grid-backend:{{ .Values.global.version }}
Expand All @@ -42,7 +51,7 @@ spec:
- name: NODE_TYPE
value: {{ .Values.node.type | default "domain" | quote }}
- name: NODE_NAME
value: {{ .Values.node.name | default .Release.Name | quote }}
value: {{ .Values.node.name | default (printf "%s-node" .Release.Name) | quote }}
- name: NODE_SIDE_TYPE
value: {{ .Values.node.side | quote }}
- name: DEFAULT_ROOT_EMAIL
Expand Down Expand Up @@ -104,8 +113,6 @@ spec:
secretKeyRef:
name: {{ .Values.seaweedfs.secretKeyName | required "seaweedfs.secretKeyName is required" }}
key: s3RootPassword
- name: SEAWEED_MOUNT_PORT
value: {{ .Values.seaweedfs.mountApi.port | quote }}
{{- end }}
# Tracing
- name: TRACE
Expand Down
9 changes: 9 additions & 0 deletions packages/grid/helm/syft/templates/frontend/frontend-deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,16 @@ spec:
labels:
{{- include "common.labels" . | nindent 8 }}
app.kubernetes.io/component: frontend
{{- if .Values.frontend.podLabels }}
{{- toYaml .Values.frontend.podLabels | nindent 8 }}
{{- end }}
{{- if .Values.frontend.podAnnotations }}
annotations: {{- toYaml .Values.frontend.podAnnotations | nindent 8 }}
{{- end }}
spec:
{{- if .Values.frontend.nodeSelector }}
nodeSelector: {{- .Values.frontend.nodeSelector | toYaml | nindent 8 }}
{{- end }}
containers:
- name: frontend-container
image: {{ .Values.global.registry }}/openmined/grid-frontend:{{ .Values.global.version }}
Expand Down