README
¶
Tanzu Hub Client
This package enables the creation of authenticated Tanzu Hub clients which in turn
enables the interaction with Tanzu Hub endpoint through GraphQL queries for the
tanzu context.
Note: The Tanzu Hub Client feature is an EXPERIMENTAL feature. The API signature and implementation are subjected to change/removal if an alternative means to provide equivalent functionality can be introduced.
Creating a Tanzu Hub Client
To create a Tanzu Hub client, use the CreateHubClient(contextName string) API
by providing the tanzu context name. An authenticated Tanzu Hub client for the specified tanzu context will be returned.
This client includes an authenticated GraphQLClient from the github.com/Khan/genqlient package
that can be used to do GraphQL queries. Internally it configures the client with an access token for each request.
By default, it will get the Tanzu Hub endpoint from the specified context metadata. To specify any custom Tanzu Hub
endpoint for testing please configure the TANZU_HUB_GRAPHQL_ENDPOINT environment variable.
Note that the authenticated client is assured to have at least 30 min access to the GraphQL endpoint. If you want a long running client beyond this period, recommendation is to reinitialize your client.
Generating the golang stub to invoke graphQL queries
There are many golang client libraries for the graphQL, however, Tanzu Plugin Runtime uses github.com/Khan/genqlient and
also returns the corresponding graphQL client as part of the Tanzu Hub client creation.
github.com/Khan/genqlient is a Go library to easily generate type-safe code to query a GraphQL API.
To help plugin authors generate the stub for the Tanzu Hub endpoint, a tanzuhub.mk has been provided.
This makefile provides an easy means for the plugin authors to initialize a hub package and also generate the stub from the graphQL queries.
To use this library plugin authors can follow the below steps:
- Copy the tanzuhub.mk to your project and import it to your
Makefilewithinclude ./tanzuhub.mk - Configure the
TANZU_HUB_SCHEMA_FILE_URLenvironment variable to theschema.graphqlof the Tanzu Hub - Run
make tanzu-hub-stub-initto initialize ahubpackage. This will create the following files under thehubpackage:genqlient.yaml: Configuration file for generating golang code from GraphQL query withgithub.com/Khan/genqlientqueries.graphql: File to write all graphQL queriesmain.go: A golang file with necessary imports to easily rungo generateto generate stub code
- Once the initialization is done, you can add your GraphQL queries to the
queries.graphqlfile - After adding new graphQL queries or updating an existing query, run
make tanzu-hub-stub-generateto generate a golang stub for the GraphQL queries- This will create a
generate.gofile under thehubpackage with golang APIs that can be consumed directly by other packages by passing the GraphQLClient available with TanzuHub client
- This will create a
Documentation
¶
Overview ¶
Package hub provides functions to create Tanzu Hub client for specific context
Index ¶
Constants ¶
const (
EnvTanzuHubGraphQLEndpoint = "TANZU_HUB_GRAPHQL_ENDPOINT"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type HubClient ¶
type HubClient struct {
// ContextName is Tanzu CLI context name
ContextName string
// GraphQLClient can be used to do graphql queries
GraphQLClient graphql.Client
}
HubClient client to talk to Tanzu Hub through GraphQL apis It includes authenticated GraphQL client from github.com/Khan/genqlient that can be used to do GraphQL queries
func CreateHubClient ¶
CreateHubClient returns an authenticated Tanzu Hub client for the specified tanzu context. This client includes an authenticated GraphQLClient from github.com/Khan/genqlient that can be used to do GraphQL queries. Internally it configures the client with CSP access token for each request
Note that the authenticated client is assured to have at least 30 min access to the GraphQL endpoint. If you want a long running client beyond this period, recommendation is to reinitialize your client.
EXPERIMENTAL: Both the function's signature and implementation are subjected to change/removal if an alternative means to provide equivalent functionality can be introduced.
Source Files