Documentation

Overview

Package container is an auto-generated package for the Kubernetes Engine API.

Builds and manages container-based applications, powered by the open source Kubernetes technology.

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

    DefaultAuthScopes reports the default set of authentication scopes to use with this package.

    Types

    type ClusterManagerCallOptions

    type ClusterManagerCallOptions struct {
    	ListClusters            []gax.CallOption
    	GetCluster              []gax.CallOption
    	CreateCluster           []gax.CallOption
    	UpdateCluster           []gax.CallOption
    	UpdateNodePool          []gax.CallOption
    	SetNodePoolAutoscaling  []gax.CallOption
    	SetLoggingService       []gax.CallOption
    	SetMonitoringService    []gax.CallOption
    	SetAddonsConfig         []gax.CallOption
    	SetLocations            []gax.CallOption
    	UpdateMaster            []gax.CallOption
    	SetMasterAuth           []gax.CallOption
    	DeleteCluster           []gax.CallOption
    	ListOperations          []gax.CallOption
    	GetOperation            []gax.CallOption
    	CancelOperation         []gax.CallOption
    	GetServerConfig         []gax.CallOption
    	GetJSONWebKeys          []gax.CallOption
    	ListNodePools           []gax.CallOption
    	GetNodePool             []gax.CallOption
    	CreateNodePool          []gax.CallOption
    	DeleteNodePool          []gax.CallOption
    	RollbackNodePoolUpgrade []gax.CallOption
    	SetNodePoolManagement   []gax.CallOption
    	SetLabels               []gax.CallOption
    	SetLegacyAbac           []gax.CallOption
    	StartIPRotation         []gax.CallOption
    	CompleteIPRotation      []gax.CallOption
    	SetNodePoolSize         []gax.CallOption
    	SetNetworkPolicy        []gax.CallOption
    	SetMaintenancePolicy    []gax.CallOption
    	ListUsableSubnetworks   []gax.CallOption
    }

      ClusterManagerCallOptions contains the retry settings for each method of ClusterManagerClient.

      type ClusterManagerClient

      type ClusterManagerClient struct {
      
      	// The call options for this service.
      	CallOptions *ClusterManagerCallOptions
      	// contains filtered or unexported fields
      }

        ClusterManagerClient is a client for interacting with Kubernetes Engine API.

        Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

        func NewClusterManagerClient

        func NewClusterManagerClient(ctx context.Context, opts ...option.ClientOption) (*ClusterManagerClient, error)

          NewClusterManagerClient creates a new cluster manager client.

          Google Kubernetes Engine Cluster Manager v1

          Example
          Output:
          
          

          func (*ClusterManagerClient) CancelOperation

            CancelOperation cancels the specified operation.

            Example
            Output:
            
            

            func (*ClusterManagerClient) Close

            func (c *ClusterManagerClient) Close() error

              Close closes the connection to the API service. The user should invoke this when the client is no longer required.

              func (*ClusterManagerClient) CompleteIPRotation

                CompleteIPRotation completes master IP rotation.

                Example
                Output:
                
                

                func (*ClusterManagerClient) Connection

                func (c *ClusterManagerClient) Connection() *grpc.ClientConn

                  Connection returns a connection to the API service.

                  Deprecated.

                  func (*ClusterManagerClient) CreateCluster

                    CreateCluster creates a cluster, consisting of the specified number and type of Google Compute Engine instances.

                    By default, the cluster is created in the project’s default network (at https://cloud.google.com/compute/docs/networks-and-firewalls#networks).

                    One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster.

                    Finally, an entry is added to the project’s global metadata indicating which CIDR range the cluster is using.

                    Example
                    Output:
                    
                    

                    func (*ClusterManagerClient) CreateNodePool

                      CreateNodePool creates a node pool for a cluster.

                      Example
                      Output:
                      
                      

                      func (*ClusterManagerClient) DeleteCluster

                        DeleteCluster deletes the cluster, including the Kubernetes endpoint and all worker nodes.

                        Firewalls and routes that were configured during cluster creation are also deleted.

                        Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren’t present when the cluster was initially created.

                        Example
                        Output:
                        
                        

                        func (*ClusterManagerClient) DeleteNodePool

                          DeleteNodePool deletes a node pool from a cluster.

                          Example
                          Output:
                          
                          

                          func (*ClusterManagerClient) GetCluster

                            GetCluster gets the details of a specific cluster.

                            Example
                            Output:
                            
                            

                            func (*ClusterManagerClient) GetJSONWebKeys

                              GetJSONWebKeys gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters.

                              Example
                              Output:
                              
                              

                              func (*ClusterManagerClient) GetNodePool

                                GetNodePool retrieves the requested node pool.

                                Example
                                Output:
                                
                                

                                func (*ClusterManagerClient) GetOperation

                                  GetOperation gets the specified operation.

                                  Example
                                  Output:
                                  
                                  

                                  func (*ClusterManagerClient) GetServerConfig

                                    GetServerConfig returns configuration info about the Google Kubernetes Engine service.

                                    Example
                                    Output:
                                    
                                    

                                    func (*ClusterManagerClient) ListClusters

                                      ListClusters lists all clusters owned by a project in either the specified zone or all zones.

                                      Example
                                      Output:
                                      
                                      

                                      func (*ClusterManagerClient) ListNodePools

                                        ListNodePools lists the node pools for a cluster.

                                        Example
                                        Output:
                                        
                                        

                                        func (*ClusterManagerClient) ListOperations

                                          ListOperations lists all operations in a project in a specific zone or all zones.

                                          Example
                                          Output:
                                          
                                          

                                          func (*ClusterManagerClient) ListUsableSubnetworks

                                            ListUsableSubnetworks lists subnetworks that are usable for creating clusters in a project.

                                            Example
                                            Output:
                                            
                                            

                                            func (*ClusterManagerClient) RollbackNodePoolUpgrade

                                              RollbackNodePoolUpgrade rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

                                              Example
                                              Output:
                                              
                                              

                                              func (*ClusterManagerClient) SetAddonsConfig

                                                SetAddonsConfig sets the addons for a specific cluster.

                                                Example
                                                Output:
                                                
                                                

                                                func (*ClusterManagerClient) SetLabels

                                                  SetLabels sets labels on a cluster.

                                                  Example
                                                  Output:
                                                  
                                                  

                                                  func (*ClusterManagerClient) SetLegacyAbac

                                                    SetLegacyAbac enables or disables the ABAC authorization mechanism on a cluster.

                                                    Example
                                                    Output:
                                                    
                                                    

                                                    func (*ClusterManagerClient) SetLocations

                                                      SetLocations sets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update (at https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.

                                                      Example
                                                      Output:
                                                      
                                                      

                                                      func (*ClusterManagerClient) SetLoggingService

                                                        SetLoggingService sets the logging service for a specific cluster.

                                                        Example
                                                        Output:
                                                        
                                                        

                                                        func (*ClusterManagerClient) SetMaintenancePolicy

                                                          SetMaintenancePolicy sets the maintenance policy for a cluster.

                                                          Example
                                                          Output:
                                                          
                                                          

                                                          func (*ClusterManagerClient) SetMasterAuth

                                                            SetMasterAuth sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.

                                                            Example
                                                            Output:
                                                            
                                                            

                                                            func (*ClusterManagerClient) SetMonitoringService

                                                              SetMonitoringService sets the monitoring service for a specific cluster.

                                                              Example
                                                              Output:
                                                              
                                                              

                                                              func (*ClusterManagerClient) SetNetworkPolicy

                                                                SetNetworkPolicy enables or disables Network Policy for a cluster.

                                                                Example
                                                                Output:
                                                                
                                                                

                                                                func (*ClusterManagerClient) SetNodePoolAutoscaling

                                                                  SetNodePoolAutoscaling sets the autoscaling settings for the specified node pool.

                                                                  Example
                                                                  Output:
                                                                  
                                                                  

                                                                  func (*ClusterManagerClient) SetNodePoolManagement

                                                                    SetNodePoolManagement sets the NodeManagement options for a node pool.

                                                                    Example
                                                                    Output:
                                                                    
                                                                    

                                                                    func (*ClusterManagerClient) SetNodePoolSize

                                                                      SetNodePoolSize sets the size for a specific node pool.

                                                                      Example
                                                                      Output:
                                                                      
                                                                      

                                                                      func (*ClusterManagerClient) StartIPRotation

                                                                        StartIPRotation starts master IP rotation.

                                                                        Example
                                                                        Output:
                                                                        
                                                                        

                                                                        func (*ClusterManagerClient) UpdateCluster

                                                                          UpdateCluster updates the settings of a specific cluster.

                                                                          Example
                                                                          Output:
                                                                          
                                                                          

                                                                          func (*ClusterManagerClient) UpdateMaster

                                                                            UpdateMaster updates the master for a specific cluster.

                                                                            Example
                                                                            Output:
                                                                            
                                                                            

                                                                            func (*ClusterManagerClient) UpdateNodePool

                                                                              UpdateNodePool updates the version and/or image type for the specified node pool.

                                                                              Example
                                                                              Output:
                                                                              
                                                                              

                                                                              type UsableSubnetworkIterator

                                                                              type UsableSubnetworkIterator struct {
                                                                              
                                                                              	// Response is the raw response for the current page.
                                                                              	// It must be cast to the RPC response type.
                                                                              	// Calling Next() or InternalFetch() updates this value.
                                                                              	Response interface{}
                                                                              
                                                                              	// InternalFetch is for use by the Google Cloud Libraries only.
                                                                              	// It is not part of the stable interface of this package.
                                                                              	//
                                                                              	// InternalFetch returns results from a single call to the underlying RPC.
                                                                              	// The number of results is no greater than pageSize.
                                                                              	// If there are no more results, nextPageToken is empty and err is nil.
                                                                              	InternalFetch func(pageSize int, pageToken string) (results []*containerpb.UsableSubnetwork, nextPageToken string, err error)
                                                                              	// contains filtered or unexported fields
                                                                              }

                                                                                UsableSubnetworkIterator manages a stream of *containerpb.UsableSubnetwork.

                                                                                func (*UsableSubnetworkIterator) Next

                                                                                  Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

                                                                                  func (*UsableSubnetworkIterator) PageInfo

                                                                                  func (it *UsableSubnetworkIterator) PageInfo() *iterator.PageInfo

                                                                                    PageInfo supports pagination. See the google.golang.org/api/iterator package for details.