add commonLabels value #3438

bastienbosser · 2022-10-14T15:05:39Z

Signed-off-by: BOSSER, Bastien [email protected]

Describe what this PR does

Add a commonLabels variable in the values.yml file that allows to add additional labels on all helm chart resources.

As you know, labels can be used to organize and to select subsets of objects. In my case of use it allows me to group the applications by category and to check by a simple command the status of it.

As examples, for all security applications, I put a label "my-cluster-name/application_group: security". Then I just have to make the command "kubectl get all -A -l my-cluster-name/application_group=security" to know the status of all applications that provide security.

Related issues

Fixes: #3437

nixpanic

Looks reasonable to me, thanks for the PR!

You will need to force-push a correction though. The subject of the commit should have a topic, and that is missing at the moment. I recommend using

deploy: add commonLabels value

or similar. The commit message itself can also have a few more details, basically copy/paste from the PR description.

Madhu-1

please add some test labels here https://github.com/ceph/ceph-csi/blob/devel/scripts/install-helm.sh#L172-L182 so that this will be get tested in CI

bastienbosser · 2022-10-26T14:32:23Z

@nixpanic I changed the commit message.
@Madhu-1 What type of test would you like me to develop? Should I just add the customLabels value in the helm deploy?

Madhu-1 · 2022-10-26T14:34:24Z

@nixpanic I changed the commit message. @Madhu-1 What type of test would you like me to develop? Should I just add the customLabels value in the helm deploy?

Just add some sample custom labels to the above script

bastienbosser · 2022-10-26T15:15:45Z

@Madhu-1 Are the tests suitable for you?

Madhu-1 · 2022-10-26T15:24:24Z

scripts/install-helm.sh

@@ -179,7 +179,7 @@ install_cephcsi_helm_charts() {
    kubectl_retry delete cm ceph-config --namespace ${NAMESPACE}

    # shellcheck disable=SC2086
-    "${HELM}" install --namespace ${NAMESPACE} --set provisioner.fullnameOverride=csi-rbdplugin-provisioner --set nodeplugin.fullnameOverride=csi-rbdplugin --set configMapName=ceph-csi-config --set provisioner.replicaCount=1 ${SET_SC_TEMPLATE_VALUES} ${RBD_SECRET_TEMPLATE_VALUES} ${RBD_CHART_NAME} "${SCRIPT_DIR}"/../charts/ceph-csi-rbd --set topology.enabled=true --set topology.domainLabels="{${NODE_LABEL_REGION},${NODE_LABEL_ZONE}}" --set provisioner.maxSnapshotsOnImage=3 --set provisioner.minSnapshotsOnImage=2
+    "${HELM}" install --namespace ${NAMESPACE} --set provisioner.fullnameOverride=csi-rbdplugin-provisioner --set nodeplugin.fullnameOverride=csi-rbdplugin --set configMapName=ceph-csi-config --set provisioner.replicaCount=1 --set-json='commonLabels={"test": "test", "un": "deux"}' ${SET_SC_TEMPLATE_VALUES} ${RBD_SECRET_TEMPLATE_VALUES} ${RBD_CHART_NAME} "${SCRIPT_DIR}"/../charts/ceph-csi-rbd --set topology.enabled=true --set topology.domainLabels="{${NODE_LABEL_REGION},${NODE_LABEL_ZONE}}" --set provisioner.maxSnapshotsOnImage=3 --set provisioner.minSnapshotsOnImage=2


looks good, can you please add some meaningful names (choose whatever you like something specific to cephcsi)

--set-json='commonLabels={"component": "ceph", "sub-component": "rbd"}'

Madhu-1

changes LGTM, please squash the commits.

humblec · 2022-10-27T04:59:19Z

scripts/install-helm.sh

@@ -179,7 +179,7 @@ install_cephcsi_helm_charts() {
    kubectl_retry delete cm ceph-config --namespace ${NAMESPACE}

    # shellcheck disable=SC2086
-    "${HELM}" install --namespace ${NAMESPACE} --set provisioner.fullnameOverride=csi-rbdplugin-provisioner --set nodeplugin.fullnameOverride=csi-rbdplugin --set configMapName=ceph-csi-config --set provisioner.replicaCount=1 ${SET_SC_TEMPLATE_VALUES} ${RBD_SECRET_TEMPLATE_VALUES} ${RBD_CHART_NAME} "${SCRIPT_DIR}"/../charts/ceph-csi-rbd --set topology.enabled=true --set topology.domainLabels="{${NODE_LABEL_REGION},${NODE_LABEL_ZONE}}" --set provisioner.maxSnapshotsOnImage=3 --set provisioner.minSnapshotsOnImage=2
+    "${HELM}" install --namespace ${NAMESPACE} --set provisioner.fullnameOverride=csi-rbdplugin-provisioner --set nodeplugin.fullnameOverride=csi-rbdplugin --set configMapName=ceph-csi-config --set provisioner.replicaCount=1 --set-json='commonLabels={"app.kubernetes.io/name": "ceph-csi-rdb", "app.kubernetes.io/managed-by": "helm"}' ${SET_SC_TEMPLATE_VALUES} ${RBD_SECRET_TEMPLATE_VALUES} ${RBD_CHART_NAME} "${SCRIPT_DIR}"/../charts/ceph-csi-rbd --set topology.enabled=true --set topology.domainLabels="{${NODE_LABEL_REGION},${NODE_LABEL_ZONE}}" --set provisioner.maxSnapshotsOnImage=3 --set provisioner.minSnapshotsOnImage=2


change below to "app.kubernetes.io/name": "ceph-csi-rdb" to "app.kubernetes.io/name": "ceph-csi-rbd"

bastienbosser · 2022-10-27T06:21:45Z

changes LGTM, please squash the commits.

Normally you can do this directly during the merge @Madhu-1

Rakshith-R · 2022-10-27T06:29:32Z

changes LGTM, please squash the commits.

Normally you can do this directly during the merge @Madhu-1

@bastienbosser
This is currently automated in cephcsi repo.
merigfyio bot will be merging this pr with rebase and merge logic after approvals and successful ci runs.
It'll be cleaner to have one commit for this pr.

Thanks !

bastienbosser · 2022-10-27T14:16:44Z

changes LGTM, please squash the commits.

Normally you can do this directly during the merge @Madhu-1

@bastienbosser This is currently automated in cephcsi repo. merigfyio bot will be merging this pr with rebase and merge logic after approvals and successful ci runs. It'll be cleaner to have one commit for this pr.

Thanks !

Done

done

nixpanic · 2022-10-28T14:04:18Z

After other PRs are done with their CI runs, this can be rebased by Mergify and de ok-to-test label can be added

Madhu-1 · 2022-10-28T19:49:11Z

@Mergifyio rebase

mergify · 2022-10-28T19:50:18Z

rebase

✅ Branch has been successfully rebased

Madhu-1 · 2022-11-01T12:02:01Z

It seems the deploying through Helm is not working. All CI jobs fail in a similar way:

job: https://jenkins-ceph-csi.apps.ocp.ci.centos.org/blue/organizations/jenkins/k8s-e2e-external-storage-1.25/detail/k8s-e2e-external-storage-1.25/31/pipeline/96

logs: https://jenkins-ceph-csi.apps.ocp.ci.centos.org/blue/rest/organizations/jenkins/pipelines/k8s-e2e-external-storage-1.25/runs/31/nodes/96/log/?start=0

Snippet:
Fri Oct 28 20:20:37 UTC 2022: 'kubectl_retry label node/minikube test.failure-domain/zone=testzone' done (ret=0)
node/minikube labeled
Error: unknown flag: --set-json
...
Maybe --set-json is something of a newer Helm version? You can change the Helm version in the build.env file.

Yes, because of the missing flag, deployment was not successful and csi pods are not running as expected. Can you please use some other existing flag to set it or we need to update the helm version in the build.env?

Pull request has been modified.

bastienbosser · 2022-11-02T07:09:01Z

I changed the helm version in the build.env file to make the tests work.

Madhu-1 · 2022-11-02T07:46:42Z

I changed the helm version in the build.env file to make the tests work.

How this value can be set if someone is using an older helm version? Do you have the sample command?

Madhu-1 · 2022-11-02T07:46:56Z

/test ci/centos/mini-e2e/k8s-1.25

Madhu-1 · 2022-11-02T07:47:30Z

/test ci/centos/mini-e2e/k8s-1.25

nixpanic · 2022-11-02T08:57:30Z

/test ci/centos/mini-e2e/k8s-1.25

Seems to run well now!

nixpanic · 2022-11-02T09:48:45Z

@Mergifyio rebase

Signed-off-by: BOSSER, Bastien <[email protected]>

mergify · 2022-11-02T09:49:42Z

rebase

✅ Branch has been successfully rebased

github-actions · 2022-11-02T09:50:05Z

/test ci/centos/k8s-e2e-external-storage/1.23

github-actions · 2022-11-02T09:50:06Z

/test ci/centos/k8s-e2e-external-storage/1.24

github-actions · 2022-11-02T09:50:07Z

/test ci/centos/k8s-e2e-external-storage/1.25

github-actions · 2022-11-02T09:50:08Z

/test ci/centos/mini-e2e-helm/k8s-1.23

github-actions · 2022-11-02T09:50:09Z

/test ci/centos/mini-e2e-helm/k8s-1.24

github-actions · 2022-11-02T09:50:10Z

/test ci/centos/mini-e2e-helm/k8s-1.25

github-actions · 2022-11-02T09:50:11Z

/test ci/centos/mini-e2e/k8s-1.23

github-actions · 2022-11-02T09:50:12Z

/test ci/centos/mini-e2e/k8s-1.24

github-actions · 2022-11-02T09:50:13Z

/test ci/centos/mini-e2e/k8s-1.25

github-actions · 2022-11-02T09:50:14Z

/test ci/centos/upgrade-tests-cephfs

github-actions · 2022-11-02T09:50:15Z

/test ci/centos/upgrade-tests-rbd

nixpanic added the component/deployment Helm chart, kubernetes templates and configuration Issues/PRs label Oct 17, 2022

nixpanic requested changes Oct 17, 2022

View reviewed changes

Madhu-1 reviewed Oct 17, 2022

View reviewed changes

bastienbosser force-pushed the feature-possibility-to-add-additional-labels branch from f88a3f1 to cdeae99 Compare October 26, 2022 14:28

Madhu-1 reviewed Oct 26, 2022

View reviewed changes

bastienbosser force-pushed the feature-possibility-to-add-additional-labels branch from 6322356 to 097f875 Compare October 26, 2022 15:57

bastienbosser requested review from nixpanic and Madhu-1 and removed request for nixpanic and Madhu-1 October 26, 2022 16:06

Madhu-1 reviewed Oct 26, 2022

View reviewed changes

humblec previously requested changes Oct 27, 2022

View reviewed changes

bastienbosser requested a review from humblec October 27, 2022 08:48

bastienbosser force-pushed the feature-possibility-to-add-additional-labels branch from 4f0da28 to 8a9d6a9 Compare October 27, 2022 14:15

Madhu-1 requested a review from nixpanic October 27, 2022 14:56

Madhu-1 previously approved these changes Oct 27, 2022

View reviewed changes

nixpanic previously approved these changes Oct 28, 2022

View reviewed changes

Madhu-1 force-pushed the feature-possibility-to-add-additional-labels branch from 8a9d6a9 to ca00435 Compare October 28, 2022 19:50

Madhu-1 added the ok-to-test Label to trigger E2E tests label Oct 28, 2022

nixpanic removed the ok-to-test Label to trigger E2E tests label Nov 1, 2022

bastienbosser force-pushed the feature-possibility-to-add-additional-labels branch from ca00435 to 7fb0387 Compare November 2, 2022 07:07

nixpanic approved these changes Nov 2, 2022

View reviewed changes

Madhu-1 approved these changes Nov 2, 2022

View reviewed changes

humblec approved these changes Nov 2, 2022

View reviewed changes

deploy: add commonLabels value

e690c63

Signed-off-by: BOSSER, Bastien <[email protected]>

Madhu-1 force-pushed the feature-possibility-to-add-additional-labels branch from 7fb0387 to e690c63 Compare November 2, 2022 09:49

nixpanic added the ok-to-test Label to trigger E2E tests label Nov 2, 2022

mergify bot merged commit dea07aa into ceph:devel Nov 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add commonLabels value #3438

add commonLabels value #3438

bastienbosser commented Oct 14, 2022

nixpanic left a comment

Madhu-1 left a comment

bastienbosser commented Oct 26, 2022

Madhu-1 commented Oct 26, 2022

bastienbosser commented Oct 26, 2022

Madhu-1 Oct 26, 2022

Madhu-1 left a comment

humblec Oct 27, 2022

bastienbosser Oct 27, 2022

bastienbosser commented Oct 27, 2022

Rakshith-R commented Oct 27, 2022

bastienbosser commented Oct 27, 2022

nixpanic commented Oct 28, 2022

Madhu-1 commented Oct 28, 2022

mergify bot commented Oct 28, 2022

Madhu-1 commented Nov 1, 2022

bastienbosser commented Nov 2, 2022

Madhu-1 commented Nov 2, 2022

Madhu-1 commented Nov 2, 2022

Madhu-1 commented Nov 2, 2022

nixpanic commented Nov 2, 2022

nixpanic commented Nov 2, 2022

mergify bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

add commonLabels value #3438

add commonLabels value #3438

Conversation

bastienbosser commented Oct 14, 2022

Describe what this PR does

Related issues

nixpanic left a comment

Choose a reason for hiding this comment

Madhu-1 left a comment

Choose a reason for hiding this comment

bastienbosser commented Oct 26, 2022

Madhu-1 commented Oct 26, 2022

bastienbosser commented Oct 26, 2022

Madhu-1 Oct 26, 2022

Choose a reason for hiding this comment

Madhu-1 left a comment

Choose a reason for hiding this comment

humblec Oct 27, 2022

Choose a reason for hiding this comment

bastienbosser Oct 27, 2022

Choose a reason for hiding this comment

bastienbosser commented Oct 27, 2022

Rakshith-R commented Oct 27, 2022

bastienbosser commented Oct 27, 2022

nixpanic commented Oct 28, 2022

Madhu-1 commented Oct 28, 2022

mergify bot commented Oct 28, 2022

✅ Branch has been successfully rebased

Madhu-1 commented Nov 1, 2022

bastienbosser commented Nov 2, 2022

Madhu-1 commented Nov 2, 2022

Madhu-1 commented Nov 2, 2022

Madhu-1 commented Nov 2, 2022

nixpanic commented Nov 2, 2022

nixpanic commented Nov 2, 2022

mergify bot commented Nov 2, 2022

✅ Branch has been successfully rebased

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022

github-actions bot commented Nov 2, 2022