Help us shape the future of Go! Take the 2026 Go Developer Survey

container

package
v0.5.3 Latest Latest
Warning

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

Go to latest
Published: May 28, 2015 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package container provides access to the Google Container Engine API.

Usage example:

import "code.google.com/p/google-api-go-client/container/v1beta1"
...
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 {
	// ClusterApiVersion: The API version of the Kubernetes master and
	// kubelets running in this cluster. Allowed value is 0.4.2, or leave
	// blank to pick up the latest stable release.
	ClusterApiVersion string `json:"clusterApiVersion,omitempty"`

	// ContainerIpv4Cidr: [Output only] The IP addresses of the container
	// pods in this cluster, in  CIDR notation (e.g. 1.2.3.4/29).
	ContainerIpv4Cidr string `json:"containerIpv4Cidr,omitempty"`

	// CreationTimestamp: [Output only] The time the cluster was created, in
	// RFC3339 text format.
	CreationTimestamp string `json:"creationTimestamp,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. The endpoint can be accessed from the internet at
	// https://username:password@endpoint/.
	//
	// See the masterAuth property of
	// this resource for username and password information.
	Endpoint string `json:"endpoint,omitempty"`

	// MasterAuth: The HTTP basic authentication information for accessing
	// the master. Because the master endpoint is open to the internet, you
	// should create a strong password.
	MasterAuth *MasterAuth `json:"masterAuth,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"`

	// NodeConfig: The machine type and image to use for all nodes in this
	// cluster. See the descriptions of the child properties of nodeConfig.
	NodeConfig *NodeConfig `json:"nodeConfig,omitempty"`

	// NodeRoutingPrefixSize: [Output only] The size of the address space on
	// each node for hosting containers.
	NodeRoutingPrefixSize int64 `json:"nodeRoutingPrefixSize,omitempty"`

	// NumNodes: The number of nodes to create in this cluster. You must
	// ensure that your Compute Engine resource quota is sufficient for this
	// number of instances plus one (to include the master). You must also
	// have available firewall and routes quota.
	NumNodes int64 `json:"numNodes,omitempty"`

	// ServicesIpv4Cidr: [Output only] The IP addresses of the Kubernetes
	// services in this cluster, in  CIDR notation (e.g. 1.2.3.4/29).
	// Service addresses are always in the 10.0.0.0/16 range.
	ServicesIpv4Cidr string `json:"servicesIpv4Cidr,omitempty"`

	// Status: [Output only] The current status of this cluster.
	Status string `json:"status,omitempty"`

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

	// Zone: [Output only] The name of the Google Compute Engine zone in
	// which the cluster resides.
	Zone string `json:"zone,omitempty"`
}

type CreateClusterRequest

type CreateClusterRequest struct {
	// Cluster: A cluster resource.
	Cluster *Cluster `json:"cluster,omitempty"`
}

type ListAggregatedClustersResponse

type ListAggregatedClustersResponse struct {
	// Clusters: A list of clusters in the project, across all zones.
	Clusters []*Cluster `json:"clusters,omitempty"`
}

type ListAggregatedOperationsResponse

type ListAggregatedOperationsResponse struct {
	// Operations: A list of operations in the project, across all zones.
	Operations []*Operation `json:"operations,omitempty"`
}

type ListClustersResponse

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

type ListOperationsResponse

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

type MasterAuth

type MasterAuth struct {
	// Password: The password to use when accessing the Kubernetes master
	// endpoint.
	Password string `json:"password,omitempty"`

	// User: The username to use when accessing the Kubernetes master
	// endpoint.
	User string `json:"user,omitempty"`
}

type NodeConfig

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

	// SourceImage: The fully-specified name of a Google Compute Engine
	// image. For example:
	// https://www.googleapis.com/compute/v1/projects/debian-cloud/global/ima
	// ges/backports-debian-7-wheezy-vYYYYMMDD (where YYYMMDD is the version
	// date).
	//
	// If specifying an image, you are responsible for ensuring its
	// compatibility with the Debian 7 backports image. We recommend leaving
	// this field blank to accept the default backports-debian-7-wheezy
	// value.
	SourceImage string `json:"sourceImage,omitempty"`
}

type Operation

type Operation struct {
	// ErrorMessage: If an error has occurred, a textual description of the
	// error.
	ErrorMessage string `json:"errorMessage,omitempty"`

	// Name: The server-assigned ID for this operation. If the operation is
	// fulfilled upfront, it may not have a resource name.
	Name string `json:"name,omitempty"`

	// OperationType: The operation type.
	OperationType string `json:"operationType,omitempty"`

	// Status: The current status of the operation.
	Status string `json:"status,omitempty"`

	// Target: [Optional] The URL of the cluster resource that this
	// operation is associated with.
	Target string `json:"target,omitempty"`

	// Zone: The name of the Google Compute Engine zone in which the
	// operation is taking place.
	Zone string `json:"zone,omitempty"`
}

type ProjectsClustersListCall

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

func (*ProjectsClustersListCall) Do

func (*ProjectsClustersListCall) Fields

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

type ProjectsClustersService

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

func NewProjectsClustersService

func NewProjectsClustersService(s *Service) *ProjectsClustersService

func (*ProjectsClustersService) List

List: Lists all clusters owned by a project across all zones.

type ProjectsOperationsListCall

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

func (*ProjectsOperationsListCall) Do

func (*ProjectsOperationsListCall) Fields

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

type ProjectsOperationsService

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

func NewProjectsOperationsService

func NewProjectsOperationsService(s *Service) *ProjectsOperationsService

func (*ProjectsOperationsService) List

List: Lists all operations in a project, across all zones.

type ProjectsService

type ProjectsService struct {
	Clusters *ProjectsClustersService

	Operations *ProjectsOperationsService

	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 (*ProjectsZonesClustersCreateCall) Fields

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 (*ProjectsZonesClustersDeleteCall) Fields

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 (*ProjectsZonesClustersGetCall) Fields

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 (*ProjectsZonesClustersListCall) Fields

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, zoneId string, createclusterrequest *CreateClusterRequest) *ProjectsZonesClustersCreateCall

Create: Creates a cluster, consisting of the specified number and type of Google Compute Engine instances, plus a Kubernetes master instance.

The cluster is created in the project's default network.

A firewall is added that allows traffic into port 443 on the master, which enables HTTPS. A firewall and a route is added for each node to allow the containers on that node to communicate with all other instances in the cluster.

Finally, a route named k8s-iproute-10-xx-0-0 is created to track that the cluster's 10.xx.0.0/16 CIDR has been assigned.

func (*ProjectsZonesClustersService) Delete

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

Delete: Deletes the cluster, including the Kubernetes master and all worker nodes.

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

func (*ProjectsZonesClustersService) Get

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

Get: Gets a specific cluster.

func (*ProjectsZonesClustersService) List

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

type ProjectsZonesOperationsGetCall

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

func (*ProjectsZonesOperationsGetCall) Do

func (*ProjectsZonesOperationsGetCall) Fields

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 (*ProjectsZonesOperationsListCall) Fields

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, zoneId string, operationId string) *ProjectsZonesOperationsGetCall

Get: Gets the specified operation.

func (*ProjectsZonesOperationsService) List

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

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

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL