gogol-container-0.0.1: Google Container Engine SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Container.Types

Contents

Description

 

Synopsis

Service Configuration

containerService :: Service Source

Default request referring to version v1 of the Google Container Engine API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

cloudPlatformScope :: OAuthScope Source

View and manage your data across Google Cloud Platform services

ListOperationsResponse

listOperationsResponse :: ListOperationsResponse Source

Creates a value of ListOperationsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lorOperations :: Lens' ListOperationsResponse [Operation] Source

A list of operations in the project in the specified zone.

CreateClusterRequest

createClusterRequest :: CreateClusterRequest Source

Creates a value of CreateClusterRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Cluster

data Cluster Source

A Google Container Engine cluster.

See: cluster smart constructor.

cStatus :: Lens' Cluster (Maybe Text) Source

Output only
The current status of this cluster.

cNodeConfig :: Lens' Cluster (Maybe NodeConfig) Source

Parameters used in creating the cluster's nodes. See the descriptions of the child properties of `nodeConfig`. If unspecified, the defaults for all child properties are used.

cNodeIPv4CIdRSize :: Lens' Cluster (Maybe Int32) Source

Output only
The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range.

cClusterIPv4CIdR :: Lens' Cluster (Maybe Text) Source

The IP address range of the container pods in this cluster, in CIDR 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`.

cInitialNodeCount :: Lens' Cluster (Maybe Int32) Source

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. You must also have available firewall and routes quota.

cCurrentNodeVersion :: Lens' Cluster (Maybe Text) Source

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.

cNetwork :: Lens' Cluster (Maybe Text) Source

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the "default" network will be used.

cInitialClusterVersion :: Lens' Cluster (Maybe Text) Source

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.

cZone :: Lens' Cluster (Maybe Text) Source

Output only
The name of the Google Compute Engine
zone
(/compute/docs/zones#available) in which the cluster resides.

cServicesIPv4CIdR :: Lens' Cluster (Maybe Text) Source

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.

cMasterAuth :: Lens' Cluster (Maybe MasterAuth) Source

The authentication information for accessing the master.

cSelfLink :: Lens' Cluster (Maybe Text) Source

Output only
Server-defined URL for the resource.

cName :: Lens' Cluster (Maybe Text) Source

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.

cCurrentMasterVersion :: Lens' Cluster (Maybe Text) Source

Output only
The current software version of the master endpoint.

cStatusMessage :: Lens' Cluster (Maybe Text) Source

Output only
Additional information about the current status of this cluster, if available.

cEndpoint :: Lens' Cluster (Maybe Text) Source

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/`. See the `masterAuth` property of this resource for username and password information.

cLoggingService :: Lens' Cluster (Maybe Text) Source

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"

cDescription :: Lens' Cluster (Maybe Text) Source

An optional description of this cluster.

cInstanceGroupURLs :: Lens' Cluster [Text] Source

Output only
The resource URLs of instance groups associated with this cluster.

cMonitoringService :: Lens' Cluster (Maybe Text) Source

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"

cCreateTime :: Lens' Cluster (Maybe Text) Source

Output only
The time the cluster was created, in
RFC3339
(https://www.ietf.org/rfc/rfc3339.txt) text format.

UpdateClusterRequest

updateClusterRequest :: UpdateClusterRequest Source

Creates a value of UpdateClusterRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

NodeConfig

nodeConfig :: NodeConfig Source

Creates a value of NodeConfig with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ncDiskSizeGb :: Lens' NodeConfig (Maybe Int32) Source

Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

ncOAuthScopes :: Lens' NodeConfig [Text] Source

The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with *gcr.io*. If unspecified, no scopes are added.

ncMachineType :: Lens' NodeConfig (Maybe Text) Source

The name of a Google Compute Engine machine type (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.

Operation

data Operation Source

Defines the operation resource. All fields are output only.

See: operation smart constructor.

operation :: Operation Source

Creates a value of Operation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

oStatus :: Lens' Operation (Maybe Text) Source

The current status of the operation.

oZone :: Lens' Operation (Maybe Text) Source

The name of the Google Compute Engine zone in which the operation is taking place.

oSelfLink :: Lens' Operation (Maybe Text) Source

Server-defined URL for the resource.

oName :: Lens' Operation (Maybe Text) Source

The server-assigned ID for the operation.

oStatusMessage :: Lens' Operation (Maybe Text) Source

If an error has occurred, a textual description of the error.

oOperationType :: Lens' Operation (Maybe Text) Source

The operation type.

oTargetLink :: Lens' Operation (Maybe Text) Source

Server-defined URL for the target of the operation.

MasterAuth

data MasterAuth Source

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

See: masterAuth smart constructor.

masterAuth :: MasterAuth Source

Creates a value of MasterAuth with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

maClientKey :: Lens' MasterAuth (Maybe Text) Source

Output only
Base64 encoded private key used by clients to authenticate to the cluster endpoint.

maUsername :: Lens' MasterAuth (Maybe Text) Source

The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint.

maClientCertificate :: Lens' MasterAuth (Maybe Text) Source

Output only
Base64 encoded public certificate used by clients to authenticate to the cluster endpoint.

maPassword :: Lens' MasterAuth (Maybe Text) Source

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.

maClusterCaCertificate :: Lens' MasterAuth (Maybe Text) Source

Output only
Base64 encoded public certificate that is the root of trust for the cluster.

ServerConfig

serverConfig :: ServerConfig Source

Creates a value of ServerConfig with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

scValidNodeVersions :: Lens' ServerConfig [Text] Source

List of valid node upgrade target versions.

scDefaultClusterVersion :: Lens' ServerConfig (Maybe Text) Source

What version this server deploys by default.

ListClustersResponse

listClustersResponse :: ListClustersResponse Source

Creates a value of ListClustersResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lcrClusters :: Lens' ListClustersResponse [Cluster] Source

A list of clusters in the project in the specified zone, or across all ones.

ClusterUpdate

clusterUpdate :: ClusterUpdate Source

Creates a value of ClusterUpdate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cuDesiredNodeVersion :: Lens' ClusterUpdate (Maybe Text) Source

The Kubernetes version to change the nodes to (typically an upgrade). Use "-" to upgrade to the latest version supported by the server.