feat: add resource migration job and troubleshooting section for upgrade failures #289
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| {{- if .Values.resourceMigration.enabled }} | ||
| apiVersion: batch/v1 | ||
| kind: Job | ||
| metadata: | ||
| name: {{ .Release.Name }}-resource-migrator | ||
| labels: | ||
| app.kubernetes.io/instance: {{ .Release.Name }} | ||
| annotations: | ||
| "helm.sh/hook": pre-install,pre-upgrade | ||
| "helm.sh/hook-weight": "2" | ||
| "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded | ||
| spec: | ||
| template: | ||
| metadata: | ||
| labels: | ||
| app.kubernetes.io/instance: {{ .Release.Name }} | ||
| spec: | ||
| serviceAccountName: {{ .Release.Name }}-resource-migrator | ||
| restartPolicy: OnFailure | ||
| {{- if .Values.resourceMigration.runAsNonRoot }} | ||
| securityContext: | ||
| runAsNonRoot: true | ||
| seccompProfile: { type: RuntimeDefault } | ||
|
Collaborator
There was a problem hiding this comment. Maybe just ? |
||
| {{- end }} | ||
| containers: | ||
| - name: migrator | ||
| image: {{ template "kubectl.image" . }} | ||
| imagePullPolicy: {{ .Values.resourceMigration.imagePullPolicy | default "IfNotPresent" }} | ||
| command: ["/bin/sh","-c"] | ||
| args: | ||
| - | | ||
| set -euo pipefail | ||
|
|
||
| command -v jq >/dev/null 2>&1 || { echo "[resource-migrator] jq is required"; exit 1; } | ||
|
|
||
| KUBECTL="kubectl" | ||
| NS="{{ .Release.Namespace }}" | ||
| STATEFULSET_NAMES="{{ trim (include "opensearch.statefulsetNames" .) }}" | ||
|
|
||
| if [ -z "$STATEFULSET_NAMES" ]; then | ||
| echo "[resource-migrator] No statefulset names configured, nothing to do" | ||
| exit 0 | ||
| fi | ||
|
|
||
| IFS=','; for STS_NAME in $STATEFULSET_NAMES; do | ||
| STS_NAME="$(echo "$STS_NAME" | xargs)" | ||
| [ -z "$STS_NAME" ] && continue | ||
|
|
||
| STS_JSON="$($KUBECTL -n "$NS" get statefulset "$STS_NAME" -o json 2>/dev/null || true)" | ||
| if [ -z "$STS_JSON" ]; then | ||
| echo "[resource-migrator] StatefulSet $STS_NAME does not exist, skipping" | ||
| continue | ||
| fi | ||
|
|
||
| # 'node.master' env is a marker of OpenSearch 1.x StatefulSets that must be | ||
| # recreated during upgrade to 2.x because ArgoCD merge cannot remove extra envs. | ||
| NODE_MASTER="$(printf '%s' "$STS_JSON" \ | ||
|
Collaborator
There was a problem hiding this comment. Can we use just |
||
| | jq -r '[.spec.template.spec.containers[].env[]? | select(.name == "node.master")] | length' 2>/dev/null || echo "0")" | ||
|
|
||
| if [ "$NODE_MASTER" -gt 0 ]; then | ||
| echo "[resource-migrator] StatefulSet $STS_NAME contains 'node.master' env (OpenSearch 1.x)" | ||
| echo "[resource-migrator] Deleting StatefulSet $STS_NAME with --cascade=orphan" | ||
| if $KUBECTL -n "$NS" delete statefulset "$STS_NAME" --cascade=orphan --ignore-not-found=true; then | ||
|
PhBouzid marked this conversation as resolved.
|
||
| echo "[resource-migrator] StatefulSet $STS_NAME deleted successfully" | ||
| else | ||
| echo "[resource-migrator][ERROR] Failed to delete StatefulSet $STS_NAME" | ||
| exit 1 | ||
| fi | ||
| else | ||
| echo "[resource-migrator] StatefulSet $STS_NAME: no 'node.master' env found, skipping" | ||
| fi | ||
| done | ||
|
|
||
| echo "[resource-migrator] done" | ||
| resources: | ||
| limits: | ||
| cpu: {{ .Values.resourceMigration.resources.limits.cpu }} | ||
| memory: {{ .Values.resourceMigration.resources.limits.memory }} | ||
| requests: | ||
| cpu: {{ .Values.resourceMigration.resources.requests.cpu }} | ||
| memory: {{ .Values.resourceMigration.resources.requests.memory }} | ||
| {{- if .Values.resourceMigration.runAsNonRoot }} | ||
| securityContext: | ||
| allowPrivilegeEscalation: false | ||
| readOnlyRootFilesystem: true | ||
| capabilities: { drop: ["ALL"] } | ||
| {{- end }} | ||
| {{- end }} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| {{- if .Values.resourceMigration.enabled }} | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: Role | ||
| metadata: | ||
| name: {{ .Release.Name }}-resource-migrator | ||
| labels: | ||
| app.kubernetes.io/instance: {{ .Release.Name }} | ||
| annotations: | ||
| "helm.sh/hook": pre-install,pre-upgrade | ||
| "helm.sh/hook-weight": "-190" | ||
| "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded | ||
| rules: | ||
| - apiGroups: ["apps"] | ||
| resources: ["statefulsets"] | ||
| verbs: ["get","list","delete"] | ||
| --- | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: RoleBinding | ||
| metadata: | ||
| name: {{ .Release.Name }}-resource-migrator | ||
| labels: | ||
| app.kubernetes.io/instance: {{ .Release.Name }} | ||
| annotations: | ||
| "helm.sh/hook": pre-install,pre-upgrade | ||
| "helm.sh/hook-weight": "-180" | ||
| "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded | ||
| subjects: | ||
| - kind: ServiceAccount | ||
| name: {{ .Release.Name }}-resource-migrator | ||
| namespace: {{ .Release.Namespace }} | ||
| roleRef: | ||
| apiGroup: rbac.authorization.k8s.io | ||
| kind: Role | ||
| name: {{ .Release.Name }}-resource-migrator | ||
| {{- end }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| {{- if .Values.resourceMigration.enabled }} | ||
| apiVersion: v1 | ||
| kind: ServiceAccount | ||
| metadata: | ||
| name: {{ .Release.Name }}-resource-migrator | ||
| labels: | ||
| app.kubernetes.io/instance: {{ .Release.Name }} | ||
| annotations: | ||
| "helm.sh/hook": pre-install,pre-upgrade | ||
| "helm.sh/hook-weight": "-200" | ||
| "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded | ||
| {{- end }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New chapters are not added to the TOC