Doc/gardenctl config #163

etiennnr · 2022-09-30T15:32:56Z

What this PR does / why we need it:
There was missing documentation on how to configure gardenctl if the kube-system namespace is blocked for a user.

So added a 2nd method to do that over CLI. I get and know that this is not an ideal solution, but it works well in the meantime

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Release note:

Added a second method to configure gardenctl which requres less premissions

etiennnr · 2022-09-30T15:34:58Z

@petersutter do you think it would also be a good idea to somehow add the landscape name (aka garden cluster identity) in the dashboard?

petersutter · 2022-10-12T08:01:53Z

@petersutter do you think it would also be a good idea to somehow add the landscape name (aka garden cluster identity) in the dashboard?

yes, I have created gardener/dashboard#1314

README.md

petersutter

/lgtm

grolu

/lgtm

etiennnr · 2022-10-12T15:09:37Z

@petersutter @grolu Please also merge as I don't have the correct rights :)

holgerkoser · 2022-10-12T15:31:27Z

README.md

+PROJECT="your-project-name" # Change to your project name
+SHOOT="your-shoot-name" # Change to any shoot's name in your project
+PREFIX="shoot--$PROJECT--$SHOOT-"$(kubectl get shoot -n garden-$PROJECT $SHOOT -ojsonpath={.metadata.uid})"-"
+STATUS=$(kubectl get shoot -n garden-$PROJECT $SHOOT -ojsonpath={.status.clusterIdentity})
+CLUSTER_IDENTITY=$(echo ${STATUS#$PREFIX}) # difference between both


Suggested change

PROJECT="your-project-name" # Change to your project name

SHOOT="your-shoot-name" # Change to any shoot's name in your project

PREFIX="shoot--$PROJECT--$SHOOT-"$(kubectl get shoot -n garden-$PROJECT $SHOOT -ojsonpath={.metadata.uid})"-"

STATUS=$(kubectl get shoot -n garden-$PROJECT $SHOOT -ojsonpath={.status.clusterIdentity})

CLUSTER_IDENTITY=$(echo ${STATUS#$PREFIX}) # difference between both

# This function should be added to your shell profile

function getClusterIdentity () {

local ns=$(kubectl get project $1 -ojsonpath={.spec.namespace});

local uid=$(kubectl get shoot -n $ns $2 -ojsonpath={.metadata.uid});

local status=$(kubectl get shoot -n $ns $2 -ojsonpath={.status.clusterIdentity});

local prefix="shoot--$1--$2-$uid-";

echo ${status#"$prefix"};

}

CLUSTER_IDENTITY=$(getClusterIdentity "your-project-name" "your-shoot-name")

Why adding a function in the shell profile? Isn't this going to be needed only once as it's just to configure gardenctl?

After all, it's going to be saved in ~/.garden/gardenctl-v2.yaml.

I also don't think that we need the function in the shell profile, this should only be a simple example on how to configure / setup gardenctl.

If we really want to extract it to a function it should handle both cases (as you mentioned out of this thread) and first try to fetch it from the kube-system namespace and if it fails ask the user to input a project and shoot name to try the fallback. Only then the project name and shoot name is relevant.

But I'm not sure if it's worth the effort / makes it more complicated

Ok. But we should not have something in our documentation where the namespace is constructed by prepending garden- to the project name. This must be changed.

That's indeed a fair point! Just added an updated commit

petersutter

/lgtm

holgerkoser

/lgtm

Co-authored-by: Peter Sutter <peter.sutter@sap.com>

etiennnr requested a review from a team as a code owner September 30, 2022 15:32

gardener-robot added needs/review Needs review size/xs Size of pull request is tiny (see gardener-robot robot/bots/size.py) labels Sep 30, 2022

gardener-robot-ci-2 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Sep 30, 2022

petersutter reviewed Oct 12, 2022

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

gardener-robot-ci-1 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 12, 2022

gardener-robot-ci-3 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 12, 2022

etiennnr requested a review from petersutter October 12, 2022 14:33

gardener-robot-ci-3 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Oct 12, 2022

petersutter approved these changes Oct 12, 2022

View reviewed changes

gardener-robot added reviewed/lgtm Has approval for merging and removed needs/review Needs review labels Oct 12, 2022

grolu approved these changes Oct 12, 2022

View reviewed changes

holgerkoser reviewed Oct 12, 2022

View reviewed changes

gardener-robot-ci-1 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Oct 13, 2022

petersutter approved these changes Oct 13, 2022

View reviewed changes

holgerkoser approved these changes Oct 21, 2022

View reviewed changes

etiennnr and others added 8 commits October 21, 2022 16:37

not quite there yet

11139a9

found a good solution

e0ae5e3

small correction

576b995

small correction 2

a1b0416

Update README.md

c967cae

Co-authored-by: Peter Sutter <peter.sutter@sap.com>

no mo export

14ed43f

no mo export 2

20a3b7c

dynamic ns

54def00

petersutter force-pushed the doc/gardenctl-config branch from f0e5b86 to 54def00 Compare October 21, 2022 14:37

gardener-robot-ci-1 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Oct 21, 2022

petersutter merged commit 2dcde47 into gardener:master Oct 21, 2022

gardener-robot added the status/closed Issue is closed (either delivered or triaged) label Oct 21, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc/gardenctl config #163

Doc/gardenctl config #163

etiennnr commented Sep 30, 2022

etiennnr commented Sep 30, 2022 •

edited

Loading

petersutter commented Oct 12, 2022

petersutter left a comment

grolu left a comment

etiennnr commented Oct 12, 2022

holgerkoser Oct 12, 2022

etiennnr Oct 12, 2022 •

edited

Loading

petersutter Oct 12, 2022

holgerkoser Oct 13, 2022

etiennnr Oct 13, 2022

petersutter left a comment

holgerkoser left a comment

-PROJECT="your-project-name" # Change to your project name
-SHOOT="your-shoot-name" # Change to any shoot's name in your project
-PREFIX="shoot--$PROJECT--$SHOOT-"$(kubectl get shoot -n garden-$PROJECT $SHOOT -ojsonpath={.metadata.uid})"-"
-STATUS=$(kubectl get shoot -n garden-$PROJECT $SHOOT -ojsonpath={.status.clusterIdentity})
-CLUSTER_IDENTITY=$(echo ${STATUS#$PREFIX}) # difference between both
+# This function should be added to your shell profile
+function getClusterIdentity () {
+  local ns=$(kubectl get project $1 -ojsonpath={.spec.namespace});
+  local uid=$(kubectl get shoot -n $ns $2 -ojsonpath={.metadata.uid});
+  local status=$(kubectl get shoot -n $ns $2 -ojsonpath={.status.clusterIdentity});
+  local prefix="shoot--$1--$2-$uid-";
+  echo ${status#"$prefix"};
+}
+CLUSTER_IDENTITY=$(getClusterIdentity "your-project-name" "your-shoot-name")

Doc/gardenctl config #163

Doc/gardenctl config #163

Conversation

etiennnr commented Sep 30, 2022

etiennnr commented Sep 30, 2022 • edited Loading

petersutter commented Oct 12, 2022

petersutter left a comment

Choose a reason for hiding this comment

grolu left a comment

Choose a reason for hiding this comment

etiennnr commented Oct 12, 2022

holgerkoser Oct 12, 2022

Choose a reason for hiding this comment

etiennnr Oct 12, 2022 • edited Loading

Choose a reason for hiding this comment

petersutter Oct 12, 2022

Choose a reason for hiding this comment

holgerkoser Oct 13, 2022

Choose a reason for hiding this comment

etiennnr Oct 13, 2022

Choose a reason for hiding this comment

petersutter left a comment

Choose a reason for hiding this comment

holgerkoser left a comment

Choose a reason for hiding this comment

etiennnr commented Sep 30, 2022 •

edited

Loading

etiennnr Oct 12, 2022 •

edited

Loading