container

package
v0.0.0-...-7b34892 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 2, 2017 License: Apache-2.0, BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Overview

Package container provides access to the Google Container Engine API.

See https://cloud.google.com/container-engine/

Usage example: 

import "google.golang.org/api/container/v1"
...
containerService, err := container.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cluster 

type Cluster struct {
	// ClusterIpv4Cidr: The IP address range of the container pods in this
	// cluster, in
	// [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
	// notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically
	// chosen or specify a `/14` block in `10.0.0.0/8` or `172.16.0.0/12`.
	ClusterIpv4Cidr string `json:"clusterIpv4Cidr,omitempty"`

	// CreateTime: [Output only] The time the cluster was created, in
	// [RFC3339](href='https://www.ietf.org/rfc/rfc3339.txt) text format.
	// @OutputOnly.
	CreateTime string `json:"createTime,omitempty"`

	// CurrentMasterVersion: [Output only] The current software version of
	// the master endpoint. @OutputOnly.
	CurrentMasterVersion string `json:"currentMasterVersion,omitempty"`

	// CurrentNodeVersion: [Output only] The current version of the node
	// software components. If they are currently at different versions
	// because they're in the process of being upgraded, this reflects the
	// minimum version of any of them. @OutputOnly.
	CurrentNodeVersion string `json:"currentNodeVersion,omitempty"`

	// Description: An optional description of this cluster.
	Description string `json:"description,omitempty"`

	// Endpoint: [Output only] The IP address of this cluster's Kubernetes
	// master endpoint. The endpoint can be accessed from the internet at
	// `https://username:password@endpoint/`. @OutputOnly. See the
	// `masterAuth` property of this resource for username and password
	// information.
	Endpoint string `json:"endpoint,omitempty"`

	// InitialClusterVersion: [Output only] The software version of
	// Kubernetes master and kubelets used in the cluster when it was first
	// created. The version can be upgraded over time. @OutputOnly.
	InitialClusterVersion string `json:"initialClusterVersion,omitempty"`

	// InitialNodeCount: The number of nodes to create in this cluster. You
	// must ensure that your Compute Engine [resource
	// quota](/compute/docs/resource-quotas) is sufficient for this number
	// of instances. You must also have available firewall and routes quota.
	InitialNodeCount int64 `json:"initialNodeCount,omitempty"`

	// InstanceGroupUrls: [Output only] The resource URLs of [instance
	// groups](/compute/docs/instance-groups/) associated with this cluster.
	// @OutputOnly.
	InstanceGroupUrls []string `json:"instanceGroupUrls,omitempty"`

	// LoggingService: The logging service that the cluster should write
	// logs to. Currently available options: * "logging.googleapis.com" -
	// the Google Cloud Logging service * "none" - no logs will be exported
	// from the cluster * "" - default value; the default is
	// "logging.googleapis.com"
	LoggingService string `json:"loggingService,omitempty"`

	// MasterAuth: The authentication information for accessing the master.
	MasterAuth *MasterAuth `json:"masterAuth,omitempty"`

	// MonitoringService: The monitoring service that the cluster should
	// write metrics to. Currently available options: *
	// "monitoring.googleapis.com" - the Google Cloud Monitoring service *
	// "none" - no metrics will be exported from the cluster * "" - default
	// value; the default is "monitoring.googleapis.com"
	MonitoringService string `json:"monitoringService,omitempty"`

	// Name: The name of this cluster. The name must be unique within this
	// project and zone, and can be up to 40 characters with the following
	// restrictions: * Lowercase letters, numbers, and hyphens only. * Must
	// start with a letter. * Must end with a number or a letter.
	Name string `json:"name,omitempty"`

	// Network: The name of the Google Compute Engine
	// [network](/compute/docs/networking#networks_1) to which the cluster
	// is connected. If left unspecified, the "default" network will be
	// used.
	Network string `json:"network,omitempty"`

	// NodeConfig: Parameters used in creating the cluster's nodes. See the
	// descriptions of the child properties of `nodeConfig`.
	NodeConfig *NodeConfig `json:"nodeConfig,omitempty"`

	// NodeIpv4CidrSize: [Output only] The size of the address space on each
	// node for hosting containers. This is provisioned from within the
	// container_ipv4_cidr range. @OutputOnly.
	NodeIpv4CidrSize int64 `json:"nodeIpv4CidrSize,omitempty"`

	// SelfLink: [Output only] Server-defined URL for the resource.
	// @OutputOnly.
	SelfLink string `json:"selfLink,omitempty"`

	// ServicesIpv4Cidr: [Output only] The IP address range of the
	// Kubernetes services in this cluster, in
	// [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
	// notation (e.g. `1.2.3.4/29`). Service addresses are typically put in
	// the last /16 from the container CIDR. @OutputOnly.
	ServicesIpv4Cidr string `json:"servicesIpv4Cidr,omitempty"`

	// Status: [Output only] The current status of this cluster.
	// @OutputOnly.
	//
	// Possible values:
	//   "STATUS_UNSPECIFIED"
	//   "PROVISIONING"
	//   "RUNNING"
	//   "RECONCILING"
	//   "STOPPING"
	//   "ERROR"
	Status string `json:"status,omitempty"`

	// StatusMessage: [Output only] Additional information about the current
	// status of this cluster, if available. @OutputOnly.
	StatusMessage string `json:"statusMessage,omitempty"`

	// Zone: [Output only] The name of the Google Compute Engine
	// [zone](/compute/docs/zones#available) in which the cluster resides.
	// @OutputOnly.
	Zone string `json:"zone,omitempty"`
}

Cluster: A Google Container Engine cluster.

type ClusterUpdate 

type ClusterUpdate struct {
	// DesiredNodeVersion: The Kubernetes version to change the nodes to
	// (typically an upgrade). Use "-" to upgrade to the latest version
	// supported by the server.
	DesiredNodeVersion string `json:"desiredNodeVersion,omitempty"`
}

ClusterUpdate: ClusterUpdate describes an update to the cluster.

type CreateClusterRequest 

type CreateClusterRequest struct {
	// Cluster: A [cluster
	// resource](/container-engine/docs/v1/projects/zones/clusters)
	Cluster *Cluster `json:"cluster,omitempty"`
}

CreateClusterRequest: CreateClusterRequest creates a cluster.

type ListClustersResponse 

type ListClustersResponse struct {
	// Clusters: A list of clusters in the project in the specified zone, or
	// across all ones.
	Clusters []*Cluster `json:"clusters,omitempty"`
}

ListClustersResponse: ListClustersResponse is the result of ListClustersRequest.

type ListOperationsResponse 

type ListOperationsResponse struct {
	// Operations: A list of operations in the project in the specified
	// zone.
	Operations []*Operation `json:"operations,omitempty"`
}

ListOperationsResponse: ListOperationsResponse is the result of ListOperationsRequest.

type MasterAuth 

type MasterAuth struct {
	// ClientCertificate: [Output only] Base64 encoded public certificate
	// used by clients to authenticate to the cluster endpoint. @OutputOnly.
	ClientCertificate string `json:"clientCertificate,omitempty"`

	// ClientKey: [Output only] Base64 encoded private key used by clients
	// to authenticate to the cluster endpoint. @OutputOnly.
	ClientKey string `json:"clientKey,omitempty"`

	// ClusterCaCertificate: [Output only] Base64 encoded public certificate
	// that is the root of trust for the cluster. @OutputOnly.
	ClusterCaCertificate string `json:"clusterCaCertificate,omitempty"`

	// Password: The password to use for HTTP basic authentication when
	// accessing the Kubernetes master endpoint. Because the master endpoint
	// is open to the internet, you should create a strong password.
	Password string `json:"password,omitempty"`

	// Username: The username to use for HTTP basic authentication when
	// accessing the Kubernetes master endpoint.
	Username string `json:"username,omitempty"`
}

MasterAuth: The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.

type NodeConfig 

type NodeConfig struct {
	// DiskSizeGb: Size of the disk attached to each node, specified in GB.
	// The smallest allowed disk size is 10GB, and the default is 100GB.
	DiskSizeGb int64 `json:"diskSizeGb,omitempty"`

	// MachineType: The name of a Google Compute Engine [machine
	// type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If
	// unspecified, the default machine type is `n1-standard-1`.
	MachineType string `json:"machineType,omitempty"`

	// OauthScopes: The set of Google API scopes to be made available on all
	// of the node VMs under the "default" service account. Currently, the
	// following scopes are necessary to ensure the correct functioning of
	// the cluster: * "https://www.googleapis.com/auth/compute" *
	// "https://www.googleapis.com/auth/devstorage.read_only"
	OauthScopes []string `json:"oauthScopes,omitempty"`
}

NodeConfig: Per-node parameters.

type Operation 

type Operation struct {
	// Name: The server-assigned ID for the operation. @OutputOnly.
	Name string `json:"name,omitempty"`

	// OperationType: The operation type. @OutputOnly.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED"
	//   "CREATE_CLUSTER"
	//   "DELETE_CLUSTER"
	//   "UPGRADE_MASTER"
	//   "UPGRADE_NODES"
	//   "REPAIR_CLUSTER"
	OperationType string `json:"operationType,omitempty"`

	// SelfLink: Server-defined URL for the resource. @OutputOnly.
	SelfLink string `json:"selfLink,omitempty"`

	// Status: The current status of the operation. @OutputOnly.
	//
	// Possible values:
	//   "STATUS_UNSPECIFIED"
	//   "PENDING"
	//   "RUNNING"
	//   "DONE"
	Status string `json:"status,omitempty"`

	// StatusMessage: If an error has occurred, a textual description of the
	// error. @OutputOnly.
	StatusMessage string `json:"statusMessage,omitempty"`

	// TargetLink: Server-defined URL for the target of the operation.
	// @OutputOnly.
	TargetLink string `json:"targetLink,omitempty"`

	// Zone: The name of the Google Compute Engine
	// [zone](/compute/docs/zones#available) in which the operation is
	// taking place. @OutputOnly.
	Zone string `json:"zone,omitempty"`
}

Operation: Defines the operation resource. All fields are output only.

type ProjectsService 

type ProjectsService struct {
	Zones *ProjectsZonesService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

type ProjectsZonesClustersCreateCall 

type ProjectsZonesClustersCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsZonesClustersCreateCall) Do 

func (c *ProjectsZonesClustersCreateCall) Do() (*Operation, error)

func (*ProjectsZonesClustersCreateCall) Fields 

func (c *ProjectsZonesClustersCreateCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsZonesClustersDeleteCall 

type ProjectsZonesClustersDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsZonesClustersDeleteCall) Do 

func (c *ProjectsZonesClustersDeleteCall) Do() (*Operation, error)

func (*ProjectsZonesClustersDeleteCall) Fields 

func (c *ProjectsZonesClustersDeleteCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsZonesClustersGetCall 

type ProjectsZonesClustersGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsZonesClustersGetCall) Do 

func (c *ProjectsZonesClustersGetCall) Do() (*Cluster, error)

func (*ProjectsZonesClustersGetCall) Fields 

func (c *ProjectsZonesClustersGetCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsZonesClustersListCall 

type ProjectsZonesClustersListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsZonesClustersListCall) Do 

func (c *ProjectsZonesClustersListCall) Do() (*ListClustersResponse, error)

func (*ProjectsZonesClustersListCall) Fields 

func (c *ProjectsZonesClustersListCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsZonesClustersService 

type ProjectsZonesClustersService struct {
	// contains filtered or unexported fields
}

func NewProjectsZonesClustersService 

func NewProjectsZonesClustersService(s *Service) *ProjectsZonesClustersService

func (*ProjectsZonesClustersService) Create 

func (r *ProjectsZonesClustersService) Create(projectId string, zone string, createclusterrequest *CreateClusterRequest) *ProjectsZonesClustersCreateCall

Create: Creates a cluster, consisting of the specified number and type of Google Compute Engine instances, plus a Kubernetes master endpoint. By default, the cluster is created in the project's [default network]('/compute/docs/networking#networks_1'). One firewall is added for the cluster. After cluster creation, the cluster 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 is being used by the cluster.

func (*ProjectsZonesClustersService) Delete 

func (r *ProjectsZonesClustersService) Delete(projectId string, zone string, clusterId string) *ProjectsZonesClustersDeleteCall

Delete: Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted.

func (*ProjectsZonesClustersService) Get 

func (r *ProjectsZonesClustersService) Get(projectId string, zone string, clusterId string) *ProjectsZonesClustersGetCall

Get: Gets a specific cluster.

func (*ProjectsZonesClustersService) List 

func (r *ProjectsZonesClustersService) List(projectId string, zone string) *ProjectsZonesClustersListCall

List: Lists all clusters owned by a project in either the specified zone or all zones.

func (*ProjectsZonesClustersService) Update 

func (r *ProjectsZonesClustersService) Update(projectId string, zone string, clusterId string, updateclusterrequest *UpdateClusterRequest) *ProjectsZonesClustersUpdateCall

Update: Update settings of a specific cluster.

type ProjectsZonesClustersUpdateCall 

type ProjectsZonesClustersUpdateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsZonesClustersUpdateCall) Do 

func (c *ProjectsZonesClustersUpdateCall) Do() (*Operation, error)

func (*ProjectsZonesClustersUpdateCall) Fields 

func (c *ProjectsZonesClustersUpdateCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsZonesOperationsGetCall 

type ProjectsZonesOperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsZonesOperationsGetCall) Do 

func (c *ProjectsZonesOperationsGetCall) Do() (*Operation, error)

func (*ProjectsZonesOperationsGetCall) Fields 

func (c *ProjectsZonesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsZonesOperationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsZonesOperationsListCall 

type ProjectsZonesOperationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsZonesOperationsListCall) Do 

func (c *ProjectsZonesOperationsListCall) Do() (*ListOperationsResponse, error)

func (*ProjectsZonesOperationsListCall) Fields 

func (c *ProjectsZonesOperationsListCall) Fields(s ...googleapi.Field) *ProjectsZonesOperationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsZonesOperationsService 

type ProjectsZonesOperationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsZonesOperationsService 

func NewProjectsZonesOperationsService(s *Service) *ProjectsZonesOperationsService

func (*ProjectsZonesOperationsService) Get 

func (r *ProjectsZonesOperationsService) Get(projectId string, zone string, operationId string) *ProjectsZonesOperationsGetCall

Get: Gets the specified operation.

func (*ProjectsZonesOperationsService) List 

func (r *ProjectsZonesOperationsService) List(projectId string, zone string) *ProjectsZonesOperationsListCall

List: Lists all operations in a project in a specific zone or all zones.

type ProjectsZonesService 

type ProjectsZonesService struct {
	Clusters *ProjectsZonesClustersService

	Operations *ProjectsZonesOperationsService
	// contains filtered or unexported fields
}

func NewProjectsZonesService 

func NewProjectsZonesService(s *Service) *ProjectsZonesService

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New 

func New(client *http.Client) (*Service, error)

type UpdateClusterRequest 

type UpdateClusterRequest struct {
	// Update: A description of the update.
	Update *ClusterUpdate `json:"update,omitempty"`
}

UpdateClusterRequest: UpdateClusterRequest updates a cluster.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.