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

Use internal Kubeconfig file instead of default kubeconfig to store kubecontext for TAP SaaS #747

Merged
merged 1 commit into from
Apr 30, 2024
Merged

Use internal Kubeconfig file instead of default kubeconfig to store kubecontext for TAP SaaS #747

merged 1 commit into from
Apr 30, 2024

Conversation

prkalle
Copy link
Contributor

@prkalle prkalle commented Apr 26, 2024 •
edited
Loading

What this PR does / why we need it

This PR made changes to switch to using the internal kubeconfig file ($HOME/.config/tanzu/kube/config kubectl') instead default kubeconfig file to store the kubecontext for TAP SaaS.

Which issue(s) this PR fixes

Fixes #

Describe testing done for PR

Logged in to TAP and able to verify the kubecontext is create in the internal kubeconfig file (~/.kube-tanzu/config kubectl)

❯  alias tk='KUBECONFIG=~/.config/tanzu/kube/config kubectl'
❯ ./bin/tanzu login
[i] API token env var is set

[ok] Successfully logged into 'Tap-SaaS-Beta3' organization and created a tanzu context
[i] Fetching recommended plugins for active context 'Tap-SaaS-Beta3'...
[ok] No recommended plugins found.
❯ ./bin/tanzu context list
  NAME            ISACTIVE  TYPE             PROJECT  SPACE
  TAP_SAAS_PRD    false     tanzu
  Tap-SaaS-Beta3  true      tanzu
  mytmc-ctx       false     mission-control  n/a      n/a
  tkg-mgmt-vc     false     kubernetes       n/a      n/a
  tt-test-selfmg  true      mission-control  n/a      n/a

[i] Use '--wide' flag to view additional columns.
❯ tk config get-contexts
CURRENT   NAME                                CLUSTER                            AUTHINFO                        NAMESPACE
*         tanzu-cli-Tap-SaaS-Beta3            tanzu-cli-Tap-SaaS-Beta3/current   tanzu-cli-Tap-SaaS-Beta3-user
          tanzu-cli-tkg-mgmt-vc@tkg-mgmt-vc   tkg-mgmt-vc                        tanzu-cli-tkg-mgmt-vc
❯ tk api-resources
NAME                        SHORTNAMES   APIVERSION                         NAMESPACED   KIND
configmaps                               v1                                 true         ConfigMap
events                                   v1                                 true         Event
limitranges                              v1                                 true         LimitRange
resourceQuotas                           v1                                 true         ResourceQuota
secrets                                  v1                                 true         Secret
serviceaccounts                          v1                                 true         ServiceAccount
localsubjectaccessreviews                authorization.k8s.io/v1            true         LocalSubjectAccessReview
selfsubjectaccessreviews                 authorization.k8s.io/v1            false        SelfSubjectAccessReview
selfsubjectrulesreviews                  authorization.k8s.io/v1            false        SelfSubjectRulesReview
subjectaccessreviews                     authorization.k8s.io/v1            false        SubjectAccessReview
events                                   events.k8s.io/v1                   true         Event
clusterrolebindings                      rbac.authorization.k8s.io/v1       false        ClusterRoleBinding
clusterroles                             rbac.authorization.k8s.io/v1       false        ClusterRole
rolebindings                             rbac.authorization.k8s.io/v1       true         RoleBinding
roles                                    rbac.authorization.k8s.io/v1       true         Role
availabilitytargets         avt          spaces.tanzu.vmware.com/v1alpha1   true         AvailabilityTarget
managednamespaces           mn           spaces.tanzu.vmware.com/v1alpha1   true         ManagedNamespace
managednamespacesets        mns          spaces.tanzu.vmware.com/v1alpha1   true         ManagedNamespaceSet
profiles                    pr           spaces.tanzu.vmware.com/v1alpha1   true         Profile
spaces                      sp           spaces.tanzu.vmware.com/v1alpha1   true         Space
traits                      tr           spaces.tanzu.vmware.com/v1alpha1   true         Trait
projects                                 ucp.tanzu.vmware.com/v1            false        Project

Now change the context to point to space and verified the kubecontext in the internal kubeconfig file is updated correctly to point to the space.

❯ ./bin/tanzu project use mfine
✓ Successfully set project to mfine
❯ ./bin/tanzu space use wfd2
✓ Successfully set space to wfd2
❯ tk api-resources
NAME                             SHORTNAMES     APIVERSION                                    NAMESPACED   KIND
configmaps                                      v1                                            true         ConfigMap
events                                          v1                                            true         Event
limitranges                                     v1                                            true         LimitRange
resourceQuotas                                  v1                                            true         ResourceQuota
secrets                                         v1                                            true         Secret
serviceaccounts                                 v1                                            true         ServiceAccount
containerapps                    capp           apps.tanzu.vmware.com/v1                      true         ContainerApp
localsubjectaccessreviews                       authorization.k8s.io/v1                       true         LocalSubjectAccessReview
selfsubjectaccessreviews                        authorization.k8s.io/v1                       false        SelfSubjectAccessReview
selfsubjectrulesreviews                         authorization.k8s.io/v1                       false        SelfSubjectRulesReview
subjectaccessreviews                            authorization.k8s.io/v1                       false        SubjectAccessReview
redisclusters                                   bitnami.caching.tanzu.vmware.com/v1alpha1     true         RedisCluster
mongodbinstances                                bitnami.database.tanzu.vmware.com/v1alpha1    true         MongoDBInstance
mysqlinstances                                  bitnami.database.tanzu.vmware.com/v1alpha1    true         MySQLInstance
postgresqlinstances                             bitnami.database.tanzu.vmware.com/v1alpha1    true         PostgreSQLInstance
kafkainstances                                  bitnami.messaging.tanzu.vmware.com/v1alpha1   true         KafkaInstance
rabbitmqclusters                                bitnami.messaging.tanzu.vmware.com/v1alpha1   true         RabbitmqCluster
certificates                     cert,certs     cert-manager.io/v1                            true         Certificate
issuers                                         cert-manager.io/v1                            true         Issuer
packages                         pkg            data.packaging.carvel.dev/v1alpha1            true         Package
events                                          events.k8s.io/v1                              true         Event
httproutes                                      gateway.networking.k8s.io/v1beta1             true         HTTPRoute
packageinstalls                  pkgi           packaging.carvel.dev/v1alpha1                 true         PackageInstall
packagerepositories              pkgr           packaging.carvel.dev/v1alpha1                 true         PackageRepository
clusterrolebindings                             rbac.authorization.k8s.io/v1                  false        ClusterRoleBinding
clusterroles                                    rbac.authorization.k8s.io/v1                  false        ClusterRole
rolebindings                                    rbac.authorization.k8s.io/v1                  true         RoleBinding
roles                                           rbac.authorization.k8s.io/v1                  true         Role
peerauthentications              pa             security.istio.io/v1beta1                     true         PeerAuthentication
preprovisionedservices                          services.tanzu.vmware.com/v1alpha1            true         PreProvisionedService
serviceinstancebindings                         services.tanzu.vmware.com/v1alpha1            true         ServiceInstanceBinding
observabilities                                 tanzu.vmware.com/v1                           true         Observability
springcloudgatewaymappings       scgm,scgms     tanzu.vmware.com/v1                           true         SpringCloudGatewayMapping
springcloudgatewayrouteconfigs   scgrc,scgrcs   tanzu.vmware.com/v1                           true         SpringCloudGatewayRouteConfig
springcloudgateways              scg,scgs       tanzu.vmware.com/v1                           true         SpringCloudGateway
syncresourcesets                 srs            ucp.tanzu.vmware.com/v1                       true         SyncResourceSet
❯ tk config get-contexts
CURRENT   NAME                                CLUSTER                            AUTHINFO                        NAMESPACE
*         tanzu-cli-Tap-SaaS-Beta3            tanzu-cli-Tap-SaaS-Beta3/current   tanzu-cli-Tap-SaaS-Beta3-user
          tanzu-cli-tkg-mgmt-vc@tkg-mgmt-vc   tkg-mgmt-vc                        tanzu-cli-tkg-mgmt-vc

Now, verify that deleting the CLI context would delete the kubecontext from the internal Kubeconfig file.

❯ ./bin/tanzu context delete Tap-SaaS-Beta3
Deleting the context entry from the config will remove it from the list of tracked contexts. You will need to use `tanzu context create` to re-create this context. Are you sure you want to continue? [y/N]: y
[i] Deleting kubeconfig context 'tanzu-cli-Tap-SaaS-Beta3' from the file '/Users/pkalle/.kube-tanzu/config'
[!] WARNING: this removed your active context, use "kubectl config use-context" to select a different one
[ok] Successfully deleted context "Tap-SaaS-Beta3"
❯ tk config get-contexts
CURRENT   NAME                                CLUSTER       AUTHINFO                NAMESPACE
          tanzu-cli-tkg-mgmt-vc@tkg-mgmt-vc   tkg-mgmt-vc   tanzu-cli-tkg-mgmt-vc
  • Testing the kubeconfig is updated but the kubecontext is not set to current if user sets the environment variable TANZU_CLI_SKIP_UPDATE_KUBECONFIG_ON_CONTEXT_USE to true
❯ export TANZU_CLI_SKIP_UPDATE_KUBECONFIG_ON_CONTEXT_USE=true

❯ tanzu context list
  NAME            ISACTIVE  TYPE             PROJECT  SPACE
  mytmc-ctx       false     mission-control  n/a      n/a
  tkg-mgmt-vc     false     kubernetes       n/a      n/a
  tt-test-selfmg  false     mission-control  n/a      n/a
  ucp             false     tanzu

[i] Use '--wide' flag to view additional columns.


❯ ./bin/tanzu login
[i] API token env var is set

[ok] Successfully logged into 'Tap-SaaS-Beta3' organization and created a tanzu context

// You can see the context (tanzu-cli-Tap-SaaS-Beta3 )  created is not set to current 
❯ tk config get-contexts
CURRENT   NAME                       CLUSTER                    AUTHINFO                        NAMESPACE
          tanzu-cli-Tap-SaaS-Beta3   tanzu-cli-Tap-SaaS-Beta3   tanzu-cli-Tap-SaaS-Beta3-user

// However user can use `--context` flag option in kubectl to use the context created in the internal kubeconfig file

❯ tk --context tanzu-cli-Tap-SaaS-Beta3 get projects
NAME                                   DISPLAYNAME
default
738fa35a-b37e-4165-8cd0-684b9c8e2314   msrinivasssa-prod-vald-01
e4a097e1-2a9b-46a1-aed7-c94894860105   vasanth
1a022e53-6dd9-475a-b13f-c7b434fdb867   mfine
....

// similarly even when user points the context to different resource in UCP , though the kubecontext is updated, the kubecontext is not set to active.
❯ ./bin/tanzu project use tanzu-platform-demo
✓ Successfully set project to tanzu-platform-demo

❯ tk config get-contexts
CURRENT   NAME                                           CLUSTER                                        AUTHINFO                        NAMESPACE
          tanzu-cli-Tap-SaaS-Beta3   tanzu-cli-Tap-SaaS-Beta3   tanzu-cli-Tap-SaaS-Beta3-user

❯ tk --context tanzu-cli-Tap-SaaS-Beta3
NAME                     AGE
spring-petclinic-space   45h
spring-music             30h
spring-metal-greg        24h
dekt-metal-1327          22h
stu-metal-3              22h
spring-metal-ai          8h
where-for-dinner         5h44m

Release note

Use internal Kubeconfig file ($HOME/.kube-tanzu/config) instead of default kubeconfig to store kubecontext for TAP SaaS

Additional information

Special notes for your reviewer

@prkalle prkalle requested a review from a team as a code owner April 26, 2024 00:05
@prkalle prkalle changed the title Switch to using internal Kubeconfig file instead of default kubeconfig to store kubecontext for TAP SaaS Use internal Kubeconfig file instead of default kubeconfig to store kubecontext for TAP SaaS Apr 26, 2024
@prkalle prkalle added the docs-impact issues with documentation impact label Apr 26, 2024
@anujc25 anujc25 added this to the v1.3.0 milestone Apr 26, 2024
prkalle
prkalle commented Apr 26, 2024
View reviewed changes
pkg/auth/tanzu/kubeconfig.go Outdated Show resolved Hide resolved
@prkalle prkalle force-pushed the feat/use_tanzu_kubeconfig_file branch 2 times, most recently from 1fbfc52 to 9f78174 Compare April 26, 2024 23:22
vuil
vuil approved these changes Apr 29, 2024
View reviewed changes
Copy link
Contributor

@vuil vuil left a comment

Choose a reason for hiding this comment

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

lgtm.

nit: I would suggest describing under testing section
the effect of setting/not setting TANZU_CLI_SKIP_UPDATE_KUBECONFIG_ON_CONTEXT_USE
to the active context of the internal kubeconfig file.

anujc25
anujc25 approved these changes Apr 30, 2024
View reviewed changes
Copy link
Contributor

@anujc25 anujc25 left a comment

Choose a reason for hiding this comment

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

LGTM.

@prkalle
Switch to using internal Kubeconfig instead of default kubeconfig to …
241630a 
…store kubecontext for TAP SaaS

Signed-off-by: Prem Kumar Kalle <[email protected]>
@prkalle prkalle force-pushed the feat/use_tanzu_kubeconfig_file branch from 9f78174 to 241630a Compare April 30, 2024 18:26
@prkalle
Copy link
Contributor Author

prkalle commented Apr 30, 2024

nit: I would suggest describing under testing section the effect of setting/not setting TANZU_CLI_SKIP_UPDATE_KUBECONFIG_ON_CONTEXT_USE to the active context of the internal kubeconfig file.

Sure, will update the PR description

@prkalle prkalle merged commit d909ef7 into vmware-tanzu:main Apr 30, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marckhouzam marckhouzam marckhouzam left review comments

@vuil vuil vuil approved these changes

@anujc25 anujc25 anujc25 approved these changes

Assignees
No one assigned
Labels
cla-not-required docs-impact issues with documentation impact
Projects
None yet
Milestone
v1.3.0
Development

Successfully merging this pull request may close these issues.
5 participants
@prkalle @marckhouzam @vuil @anujc25 @vmwclabot