Experimental: Set the Tanzu Hub endpoint when creating `tanzu` context #734

anujc25 · 2024-04-16T19:24:55Z

What this PR does / why we need it

Set the Tanzu Hub endpoint by fetching it from CSP when creating the tanzu context
The configured endpoint is supposed to be used for creating the Tanzu Hub Client Experimental: Add support to create the Tanzu Hub client tanzu-plugin-runtime#175

Which issue(s) this PR fixes

Fixes #

Describe testing done for PR

$ tz login --staging --endpoint https://api.tanzu-dev.cloud.vmware.com
[i] Opening the browser window to complete the login
Log in by visiting this link:

    https://console-stg.cloud.vmware.com/csp/gateway/discovery?client_id=tanzu-cli-client-id&code_challenge=qvaHqJ1OM_170c3Bf5AP6ZkSbSIet8OiqX1RtPWMcx8&code_challenge_method=S256&redirect_uri=http%3A%2F%2F127.0.0.1%3A56866%2Fcallback&response_type=code&state=e9d6d53b690d4539fb13ee975bfe7014

    Optionally, paste your authorization code: [...]


[ok] Successfully logged into 'TAP pre-integration' organization and created a tanzu context
[i] Fetching recommended plugins for active context 'TAP_pre-integration-staging-d03c5c97'...
[ok] No recommended plugins found.

$ cat ~/.config/tanzu/config-ng.yaml
...
    - name: TAP_pre-integration-staging-d03c5c97
      target: tanzu
      contextType: tanzu
      globalOpts:
        endpoint: https://api.tanzu-dev.cloud.vmware.com
        auth:
            issuer: https://console-stg.cloud.vmware.com/csp/gateway/am/api
            userName: anujc
            permissions:
                - external/39721d32-3962-4a75-83d9-9b3dae23c39d/tap:viewer
                - external/39721d32-3962-4a75-83d9-9b3dae23c39d/tap:admin
                - csp:org_member
                - external/39721d32-3962-4a75-83d9-9b3dae23c39d/tap:member
            accessToken: ...
            IDToken: ...
            refresh_token: ...
            expiration: 2024-04-23T00:08:46.392013-07:00
            type: id-token
      clusterOpts:
        endpoint: https://api.tanzu-dev.cloud.vmware.com/org/ae93ebb4-a249-4553-aa1e-c87c4b7f75e5
        path: /Users/anujc/.kube/config
        context: tanzu-cli-TAP_pre-integration-staging-d03c5c97
      discoverySources: []
      additionalMetadata:
        tanzuHubEndpoint: https://be.symphony-dev.com/hub
        tanzuMissionControlEndpoint: https://tmc.tanzu-dev.cloud.vmware.com
        tanzuOrgID: ae93ebb4-a249-4553-aa1e-c87c4b7f75e5
        tanzuOrgName: TAP pre-integration
...

Release note

Experimental: Configure the Tanzu Hub endpoint when creating the `tanzu` context

Additional information

Special notes for your reviewer

go.mod

marckhouzam · 2024-05-01T21:05:53Z

pkg/command/context.go

+	if err != nil {
+		log.V(7).Infof("unable to get Tanzu Hub endpoint. Error: %v", err.Error())
+	} else {
+		c.AdditionalMetadata[config.TanzuHubEndpointKey] = tanzuHubEndpoint


This sets a new field in the metadata but in the call below updateTanzuContextMetadata I think we completely overwrite the metadata with the one from the existing context and we loose the tanzu hub field.

Amm. We only overwrite the metadata if the same context already exists right? So, will this be an issue for new contexts?

can we move this to after L666?

Good point @anujc25. Could the endpoint change on a re-login?

Upgrading an existing context when we first release this feature would be impacted but maybe that’s not a big deal?

Sorry, I didn't see the further discussion on this thread. But I have updated the PR to account for re-login with the recent change.

vuil · 2024-05-01T21:56:59Z

pkg/auth/csp/tanzu.go

+	}
+
+	for _, s := range services.ServicesList {
+		if s.ProductIdentifier == "TANZU-SAAS" && strings.Contains(s.DisplayName, "Tanzu Application Platform") { // TODO: Can this be improved to use some unique id?


Not blocking, but maybe as a followup:
This looks like a check that could use some flexibility.
That is, if any of the string patterns could be subjected to change. Perhaps using a default set now, but having it be updatable via Central config could be an option?

Good point. I will create a follow up PR to use Central Configuration Option to fetch this details.

vuil · 2024-05-01T22:01:43Z

pkg/command/context.go

+	if err != nil {
+		log.V(7).Infof("unable to get Tanzu Hub endpoint. Error: %v", err.Error())
+	} else {
+		c.AdditionalMetadata[config.TanzuHubEndpointKey] = tanzuHubEndpoint


can we move this to after L666?

vuil

lgtm, modulo the go dep update

vmware-tanzu#734) * Fetch Tanzu Hub endpoint from CSP when creating the `tanzu` context

#734) * Fetch Tanzu Hub endpoint from CSP when creating the `tanzu` context

anujc25 requested a review from a team as a code owner April 16, 2024 19:24

vmwclabot added the cla-not-required label Apr 16, 2024

anujc25 marked this pull request as draft April 16, 2024 19:25

anujc25 force-pushed the set-tanzu-hub-endpoint-in-context branch 2 times, most recently from e1f5777 to 01765fc Compare April 23, 2024 06:19

anujc25 changed the title ~~Draft: Set the Tanzu Hub endpoint when creating tanzu context~~ Experimental: Set the Tanzu Hub endpoint when creating tanzu context Apr 23, 2024

anujc25 marked this pull request as ready for review April 23, 2024 06:31

anujc25 force-pushed the set-tanzu-hub-endpoint-in-context branch 3 times, most recently from ec5baff to 03c7b3b Compare April 23, 2024 06:36

marckhouzam reviewed May 1, 2024

View reviewed changes

vuil reviewed May 1, 2024

View reviewed changes

vuil approved these changes May 1, 2024

View reviewed changes

anujc25 added 2 commits May 1, 2024 15:41

Fetch Tanzu Hub endpoint from CSP when creating tanzu context

515f859

Configure tanzuHubEndpoint as part of updateTanzuContextMetadata

47752df

anujc25 force-pushed the set-tanzu-hub-endpoint-in-context branch from 8282cdd to 47752df Compare May 1, 2024 22:42

anujc25 merged commit 790c57b into vmware-tanzu:main May 1, 2024
7 checks passed

vuil pushed a commit to vuil/tanzu-cli that referenced this pull request May 1, 2024

Experimental: Set the Tanzu Hub endpoint when creating tanzu context (

6332970

vmware-tanzu#734) * Fetch Tanzu Hub endpoint from CSP when creating the `tanzu` context

vuil pushed a commit that referenced this pull request May 1, 2024

Experimental: Set the Tanzu Hub endpoint when creating tanzu context (

5e73d1e

#734) * Fetch Tanzu Hub endpoint from CSP when creating the `tanzu` context

marckhouzam added this to the v1.3.0 milestone May 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Experimental: Set the Tanzu Hub endpoint when creating `tanzu` context #734

Experimental: Set the Tanzu Hub endpoint when creating `tanzu` context #734

anujc25 commented Apr 16, 2024 •

edited

marckhouzam May 1, 2024

anujc25 May 1, 2024

vuil May 1, 2024

marckhouzam May 1, 2024

anujc25 May 1, 2024

vuil May 1, 2024 •

edited

anujc25 May 1, 2024

vuil May 1, 2024

vuil left a comment

Experimental: Set the Tanzu Hub endpoint when creating tanzu context #734

Experimental: Set the Tanzu Hub endpoint when creating tanzu context #734

Conversation

anujc25 commented Apr 16, 2024 • edited

What this PR does / why we need it

Which issue(s) this PR fixes

Describe testing done for PR

Release note

Additional information

Special notes for your reviewer

marckhouzam May 1, 2024

Choose a reason for hiding this comment

anujc25 May 1, 2024

Choose a reason for hiding this comment

vuil May 1, 2024

Choose a reason for hiding this comment

marckhouzam May 1, 2024

Choose a reason for hiding this comment

anujc25 May 1, 2024

Choose a reason for hiding this comment

vuil May 1, 2024 • edited

Choose a reason for hiding this comment

anujc25 May 1, 2024

Choose a reason for hiding this comment

vuil May 1, 2024

Choose a reason for hiding this comment

vuil left a comment

Choose a reason for hiding this comment

Experimental: Set the Tanzu Hub endpoint when creating `tanzu` context #734

Experimental: Set the Tanzu Hub endpoint when creating `tanzu` context #734

anujc25 commented Apr 16, 2024 •

edited

vuil May 1, 2024 •

edited