package proto.cloudprovider
Get desktop application:
View/edit binary Protocol Buffers messages
message
appengine.proto:11Configuration for the Google App Engine (GAE) provider.
Used in: ,
optional enabled = 1
Whether the provider is enabled.
repeated accounts = 2
The list of configured accounts.
string primaryAccount = 3
The name of the primary account.
message
appengine.proto:23Configuration for an App Engine account.
Used in:
int32 cachingIntervalSeconds = 1
The interval in seconds at which Spinnaker will poll for updates in your App Engine clusters.
string environment = 2
The environment name for the account. Many accounts can share the same environment (e.g., dev, test, prod).
GcloudReleaseTrack gcloudReleaseTrack = 3
The gcloud release track that Spinnaker will use when deploying to App Engine.
string gitHttpsUsername = 4
A username to be used when connecting to a remote git repository server over HTTPS. If set, `gitHttpsPassword` must also be set.
string gitHttpsPassword = 5
A password to be used when connecting to a remote git repository server over HTTPS. If set, `gitHttpsUsername` must also be set.
string githubOAuthAccessToken = 6
An OAuth token provided by Github for connecting to a git repository over HTTPS. See https://help.github.com/articles/creating-an-access-token-for-command-line-use for more information.
string jsonPath = 7
The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
string localRepositoryDirectory = 8
A local directory to be used to stage source files for App Engine deployments within Clouddriver. Defaults to `/var/tmp/clouddriver`.
repeated string omitServices = 9
A list of regular expressions. Any service matching one of these regexes will be ignored by Spinnaker.
repeated string omitVersions = 10
A list of regular expressions. Any version matching one of these regexes will be ignored by Spinnaker.
string project = 11
The Google Cloud Platform project this Spinnaker account will manage.
optional permissions = 12
Fiat permissions configuration.
repeated string requiredGroupMembership = 13
(Deprecated): List of required Fiat permission groups. Configure `permissions` instead.
repeated string services = 14
A list of regular expressions. Any service matching one of these regexes will be indexed by Spinnaker (unless the service also matches a regex in `omitServices`).
string sshKnownHostsFilePath = 15
The path to a `known_hosts` file to be used when connecting with a remote git repository over SSH.
string sshPrivateKeyFilePath = 16
The path to an SSH private key to be used when connecting with a remote git repository over SSH. If set, `sshPrivateKeyPassphrase` must also be set.
string sshPrivateKeyPassphrase = 17
The passphrase to an SSH private key to be used when connecting with a remote git repository over SSH. If set, `sshPrivateKeyFilePath` must also be set.
optional sshTrustUnknownHosts = 18
Enabling this flag will allow Spinnaker to connect with a remote git repository over SSH without verifying the server's IP address against a `known_hosts` file. Defaults to false.
repeated string versions = 19
A list of regular expressions. Any version matching one of these regexes will be indexed by Spinnaker (unless the version also matches a regex in `omitVersions`).
string name = 20
The name of the account.
message
aws.proto:11Configuration for the AWS provider.
Used in: , ,
optional enabled = 1
Whether the provider is enabled.
repeated accounts = 2
The list of configured accounts.
string primaryAccount = 3
The name of the primary account.
string accessKeyId = 4
Your AWS Access Key ID. Note that if you are baking AMIs with Rosco, you may also need to set `AwsBakeryDefaults.awsAccessKey`.
string secretAccessKey = 5
Your AWS Secret Key. Note that if you are baking AMIs with Rosco, you may also need to set `AwsBakeryDefaults.awsSecretKey`.
repeated defaultRegions = 6
List of default regions.
optional features = 7
Configuration for AWS-specific features.
optional bakeryDefaults = 8
Configuration for Spinnaker's image bakery.
string defaultKeyPairTemplate = 9
A template for generating the name of the AWS key-pair from the name of the account; only used for accounts where defaultKeyPair is not specified.
optional defaults = 10
Default values for AWS deployments.
message
aws.proto:53Configuration for an AWS account.
Used in:
string accountId = 1
The AWS account ID to manage. See http://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html for more information.
string assumeRole = 2
If set, Spinnaker will configure a credentials provider that uses AWS Security Token Service to assume the specified role. Examples: `user/spinnaker`, `role/spinnakerManaged`.
string defaultKeyPair = 3
The name of the AWS key-pair to use. See http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html for more information.
string discovery = 4
The endpoint at which your Eureka discovery system is reachable. See https://github.com/Netflix/eureka for more information. Example: `http://.eureka.url.to.use:8080/eureka-server/v2`. Using will make Spinnaker use AWS regions in the hostname to access discovery so that you can have discovery for multiple regions.
string edda = 5
The endpoint at which Edda is reachable. Edda is not a hard dependency of Spinnaker, but is helpful for reducing the request volume against AWS. See https://github.com/Netflix/edda for more information.
string environment = 6
The environment name for the account. Many accounts can share the same environment (e.g., dev, test, prod).
optional permissions = 7
Fiat permissions configuration.
repeated string requiredGroupMembership = 8
(Deprecated): List of required Fiat permission groups. Configure `permissions` instead.
repeated lifecycleHooks = 9
List of configured AWS lifecycle hooks.
repeated regions = 12
List of configured AWS regions.
string name = 13
The name of the account.
string externalId = 14
Optional parameter used to identify and control access to AWS resources. Set this to the same value as the ExternalID parameter in the trust policy for the role you want to assume.
message
aws.proto:113Configuration for Spinnaker's image bakery.
Used in:
string awsAccessKey = 1
The default access key used to communicate with AWS.
string awsSecretKey = 2
The secret key used to communicate with AWS.
string awsSubnetId = 3
If using VPC, the default ID of the subnet, such as `subnet-12345def`, where Packer will launch the EC2 instance. This field is required if you are using a non-default VPC.
string awsVpcId = 4
If launching into a VPC subnet, Packer needs the VPC ID in order to create a temporary security group within the VPC. Requires `subnet_id` to be set. If this default value is left blank, Packer will try to get the VPC ID from `awsSubnetId`.
optional awsAssociatePublicIpAddress = 5
If using a non-default VPC, public IP addresses are not provided by default. If this is enabled, your new instance will get a Public IP.
string defaultVirtualizationType = 6
The default type of virtualization for the AMI you are building. This option must match the supported virtualization type of `AwsVirtualizationSettings.sourceAmi`. Acceptable values: `pv`, `hvm`.
repeated baseImages = 7
List of configured base images.
string templateFile = 8
This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer, or supplied as described here: https://spinnaker.io/setup/bakery/.
message
aws.proto:161Base image configuration.
Used in:
string id = 1
This is the identifier used by AWS to find this base image.
string shortDescription = 2
A short description to help human operators identify the image.
string detailedDescription = 3
A long description to help human operators identify the image.
string packageType = 4
This is used to help Spinnaker's bakery download the build artifacts you supply it with. For example, specifying deb indicates that your artifacts will need to be fetched from a debian repository.
string templateFile = 5
The name of the Packer template that will be used to bake images from this base image. The template file must be found in this list: https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer, or supplied as described here: https://spinnaker.io/setup/bakery/.
message
aws.proto:152Configuration for a base image for the AWS provider's bakery.
Used in:
optional baseImage = 1
Base image configuration.
repeated virtualizationSettings = 2
Base image virtualization settings.
message
aws.proto:47Configuration for defaults for AWS deployments.
Used in:
string iamRole = 1
The default IAM role to use for deployments, when not otherwise specified.
message
aws.proto:253Configuration for AWS-specific features.
Used in:
optional cloudFormation = 1
Configuration for AWS CloudFormation.
message
aws.proto:258Configuration for AWS CloudFormation.
Used in:
optional enabled = 1
Whether AWS CloudFormation is enabled.
message
aws.proto:229Configuration for AWS Auto Scaling Lifecycle Hooks. For more information, see: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html
Used in:
string defaultResult = 1
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. Acceptable values: `CONTINUE`, `ABANDON`.
int32 heartbeatTimeout = 2
Set the heartbeat timeout in seconds for the lifecycle hook. Instances can remain in a wait state for a finite period of time. Must be greater than or equal to 30 and less than or equal to 7200. The default is 3600 (one hour).
string lifecycleTransition = 3
Type of lifecycle transition. Acceptable values: `autoscaling:EC2_INSTANCE_LAUNCHING`, `autoscaling:EC2_INSTANCE_TERMINATING`
string notificationTargetARN = 4
The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.
string roleARN = 5
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
message
aws.proto:107An AWS region.
Used in: ,
string name = 1
The name of the region.
message
aws.proto:187Base image virtualization settings.
Used in:
string region = 1
The name of the region in which to launch the EC2 instance to create the AMI.
string virtualizationType = 2
The type of virtualization for the AMI you are building. This option must match the supported virtualization type of `sourceAmi`. Acceptable values: `pv`, `hvm`.
string instanceType = 3
The EC2 instance type to use while building the AMI, such as `t2.small`.
string sourceAmi = 4
The source AMI whose root volume will be copied and provisioned on the currently running instance. This must be an EBS-backed AMI with a root volume snapshot that you have access to.
string sshUserName = 5
The username to connect to SSH with. Required if using SSH.
string winRmUserName = 6
The username to use to connect to WinRM.
string spotPrice = 7
The maximum hourly price to pay for a spot instance to create the AMI. Spot instances are a type of instance that EC2 starts when the current spot price is less than the maximum price you specify. Spot price will be updated based on available spot instance capacity and current spot instance requests. It may save you some costs. You can set this to `auto` for Packer to automatically discover the best spot price or to "0" to use an on demand instance (default).
string spotPriceAutoProduct = 8
Required if `spotPrice` is set to `auto`. This tells Packer what sort of AMI you are launching to find the best spot price. This must be one of: `Linux/UNIX`, `SUSE Linux`, `Windows`, `Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)`, `Windows (Amazon VPC)`.
message
azure.proto:11Configuration for the Azure provider.
Used in: , ,
optional enabled = 1
Whether the provider is enabled.
repeated accounts = 2
The list of configured accounts.
string primaryAccount = 3
The name of the primary account.
optional bakeryDefaults = 4
Configuration for Spinnaker's image bakery.
message
azure.proto:26Configuration for an Azure account.
Used in:
string name = 1
The name of the account.
string appKey = 2
(Required) The `appKey` (password) of your service principal.
string clientId = 3
(Required) The `clientId` (also called `appId`) of your service principal.
string defaultKeyVault = 4
(Required) The name of a KeyVault that contains the user name, password, and ssh public key used to create VMs
string defaultResourceGroup = 5
(Required) The default resource group to contain any non-application specific resources.
string environment = 6
The environment name for the account. Many accounts can share the same environment (e.g., dev, test, prod).
string objectId = 7
The `objectId` of your service principal. This is only required if using Packer to bake Windows images.
string packerResourceGroup = 8
The resource group to use if baking images with Packer.
string packerStorageAccount = 9
The storage account to use if baking images with Packer.
optional permissions = 10
Fiat permissions configuration.
repeated string requiredGroupMembership = 11
(Deprecated): List of required Fiat permission groups. Configure `permissions` instead.
repeated string regions = 12
The Azure regions this Spinnaker account will manage.
string subscriptionId = 13
(Required) The `subscriptionId` to which your service principal is assigned.
string tenantId = 14
(Required) The `tenantId` to which your service principal is assigned.
optional useSshPublicKey = 15
If true, the SSH public key is used to provision the linux VM. If false, the password is used instead.
message
azure.proto:81Configuration for Spinnaker's image bakery.
Used in:
repeated baseImages = 1
List of configured base images.
message
azure.proto:93Base image configuration.
Used in:
string shortDescription = 1
A short description to help human operators identify the image.
string detailedDescription = 2
A long description to help human operators identify the image.
string publisher = 3
(Required) The Publisher name for your base image. See https://aka.ms/azspinimage to get a list of images.
string offer = 4
(Required) The offer for your base image. See https://aka.ms/azspinimage to get a list of images.
string sku = 5
(Required) The SKU for your base image. See https://aka.ms/azspinimage to get a list of images.
string version = 6
The version of your base image. This defaults to `latest` if not specified.
string packageType = 7
This is used to help Spinnaker's bakery download the build artifacts you supply it with. For example, specifying `deb` indicates that your artifacts will need to be fetched from a debian repository.
string templateFile = 8
This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list: https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer, or supplied as described here: https://spinnaker.io/setup/bakery/.
message
azure.proto:87Configuration for a base image for the Azure provider's bakery.
Used in:
optional baseImage = 1
Base image configuration.
message
cloudfoundry.proto:11Configuration for the Cloud Foundry provider.
Used in: ,
optional enabled = 1
Whether the provider is enabled.
repeated accounts = 2
The list of configured accounts.
string primaryAccount = 3
The name of the primary account.
message
cloudfoundry.proto:23Configuration for a Spinnaker Cloud Foundry account.
Used in:
string name = 1
The name of the account.
string api = 2
(Required) Host of the Cloud Foundry Foundation API endpoint (e.g., `api.sys.somesystem.com`).
string appsManagerUri = 3
HTTP(S) URL of the Apps Manager application for the Cloud Foundry Foundation (e.g., `https://apps.sys.somesystem.com`).
string environment = 4
The environment name for the account. Many accounts can share the same environment (e.g., dev, test, prod).
string metricsUri = 5
HTTP(S) URL of the metrics application for the Cloud Foundry Foundation (e.g., `https://metrics.sys.somesystem.com`).
string password = 6
(Required) Password for the account to use for this Cloud Foundry Foundation.
optional skipSslValidation = 7
(Default: `false`) Skip SSL server certificate validation of the API endpoint.
string user = 8
(Required) User name for the account to use for this Cloud Foundry Foundation.
optional permissions = 9
Fiat permissions configuration.
repeated string requiredGroupMembership = 10
(Deprecated): List of required Fiat permission groups. Configure `permissions` instead.
message
google.proto:154Configuration for Consul.
Used in:
optional enabled = 1
Whether Consul is enabled.
string agentEndpoint = 2
Reachable Consul node endpoint connected to the Consul cluster. Defaults to localhost.
int32 agentPort = 3
Port consul is running on for every agent. Defaults to 8500.
repeated string datacenters = 4
List of data centers to cache and keep updated. Defaults to all.
message
dcos.proto:11Configuration for the DC/OS (Distributed Cloud Operating System) provider.
Used in: ,
optional enabled = 1
Whether the provider is enabled.
repeated accounts = 2
The list of configured accounts.
string primaryAccount = 3
The name of the primary account.
repeated clusters = 4
The list of configured clusters.
message
dcos.proto:26Credentials to authenticate against one or more DC/OS clusters.
Used in:
string name = 1
(Required) The name of the account.
repeated clusters = 2
(Required) The clusters against which this account will authenticate.
string environment = 3
The environment name for the account. Many accounts can share the same environment (e.g., dev, test, prod).
repeated dockerRegistries = 4
(Required) The list of Docker registries to use with this DC/OS account.
optional permissions = 5
Fiat permissions configuration.
repeated string requiredGroupMembership = 6
(Deprecated) List of required Fiat permission groups. Configure `permissions` instead.
message
dcos.proto:49Configuration for a DC/OS cluster associated with a `DcosAccount`.
Used in:
string name = 1
(Required) The name of the cluster. Must match the name of a `DcosCluster` defined for this provider.
string uid = 2
(Required) User or service account identifier.
string serviceKeyFile = 3
Path to a file containing the secret key for service account authentication. If set, `password` should not be set.
string password = 4
Password for a user account. If set, `serviceKeyFile` should not be set.
message
dcos.proto:96Configuration for a Docker registry associated with a `DcosAccount`.
Used in:
string accountName = 1
The name of the Docker registry. Must be the name of an account configured with the Docker registry provider.
message
dcos.proto:66Configuration for a DC/OS cluster.
Used in:
string name = 1
(Required) The name of the cluster.
string caCertFile = 2
Root certificate file to trust for connections to the cluster.
string dcosUrl = 3
(Required) URL of the endpoint for the DC/OS cluster's admin router.
optional loadBalancer = 4
Configuration for a DC/OS load balancer.
optional insecureSkipTlsVerify = 5
If `true`, disables verification of certificates from the cluster (insecure).
message
dcos.proto:85Configuration for a DC/OS load balancer.
Used in:
string image = 1
Marathon-lb image to use when creating a load balancer with Spinnaker.
string serviceAccountSecret = 2
Name of the secret to use for allowing marathon-lb to authenticate with the cluster. Only necessary for clusters with strict or permissive security.
message
docker_registry.proto:11Configuration for the Docker Registry provider.
Used in: ,
optional enabled = 1
Whether the provider is enabled.
repeated accounts = 2
The list of configured accounts.
string primaryAccount = 3
The name of the primary account.
message
docker_registry.proto:23A credential able to authenticate against a set of Docker repositories.
Used in:
string name = 1
The name of the account.
string address = 2
(Required) The registry address from which to pull and deploy images (e.g., `https://index.docker.io`).
int32 cacheIntervalSeconds = 3
The number of seconds between polling the Docker registry. Certain registries are sensitive to over-polling, and larger intervals (e.g., 10 minutes = 600 seconds) are desirable if you experience rate limiting. Defaults to `30`.
int32 cacheThreads = 4
The number of threads on which to cache all provided repositories. Really only useful if you have a ton of repos. Defaults to 1.
int32 clientTimeoutMillis = 5
Timeout in milliseconds for provided repositories. Defaults to `60,000`.
string email = 6
The email associated with your Docker registry. Often this only needs to be well-formed, rather than be a real address.
string environment = 7
The environment name for the account. Many accounts can share the same environment (e.g., dev, test, prod).
optional insecureRegistry = 8
If `true`, Spinnaker will treat the Docker registry as insecure and not validate the SSL certificate. Defaults to `false`.
int32 paginateSize = 9
Pagination size for the Docker `repository _catalog` endpoint. Defaults to `100`.
string password = 10
The Docker registry password. Only one of `password`, `passwordCommand`, and `passwordFile` should be specified.
string passwordCommand = 11
Command to retrieve Docker token/password. The command must be available in the environment. Only one of `password`, `passwordCommand`, and `passwordFile` should be specified.
string passwordFile = 12
The path to a file containing your Docker password in plaintext (not a Docker `config.json` file). Only one of `password`, `passwordCommand`, and `passwordFile` should be specified.
optional permissions = 13
Fiat permissions configuration.
repeated string requiredGroupMembership = 14
(Deprecated) List of required Fiat permission groups. Configure `permissions` instead.
repeated string repositories = 15
An optional list of repositories from which to cache images. If not provided, Spinnaker will attempt to read accessible repositories from the `registries _catalog` endpoint. In the case of registries that support nested paths, like GCR, you can target nested paths by including them sans their registry domain. For example: `gcr.io/my-project/path/to/image` => `my-project/path/to/image`
optional sortTagsByDate = 16
If `true`, Spinnaker will sort tags by creation date. Defaults to `false`. Not recommended for use with large registries; sorting performance scales poorly due to limitations of the Docker V2 API.
optional trackDigests = 17
If `true`, Spinnaker will track digest changes. This is not recommended because it greatly increases queries to the registry, and most registries are flaky. Defaults to `false`.
string username = 18
The username associated with this Docker registry.
message
ecs.proto:11Configuration for the ECS provider.
Used in: ,
optional enabled = 1
Whether the provider is enabled.
repeated accounts = 2
The list of configured accounts.
string primaryAccount = 3
The name of the primary account.
message
ecs.proto:23Configuration for an ECS account.
Used in:
string name = 1
The name of the account.
string environment = 2
The environment name for the account. Many accounts can share the same environment (e.g., dev, test, prod).
string awsAccount = 3
(Required) Provide the name of the AWS account associated with this ECS account. See https://github.com/spinnaker/clouddriver/blob/master/clouddriver-ecs/README.md for more information.
optional permissions = 4
Fiat permissions configuration.
repeated string requiredGroupMembership = 5
(Deprecated) List of required Fiat permission groups. Configure `permissions` instead.
Represents a release track of the gcloud tool.
Used in:
UNSPECIFIED = 0
Unspecified. Do not directly use, instead omit the field.
STABLE = 1
Standard release track; runs commands via `gcloud...`
BETA = 2
Alpha release track; runs commands via `gcloud beta...`
ALPHA = 3
Alpha release track; runs commands via `gcloud alpha...`
message
google.proto:81Configuration for Spinnaker's image bakery.
Used in:
string templateFile = 1
The name of the Packer template that will be used to bake images from this base image. The template file must be found in this list: https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer, or supplied as described here: https://spinnaker.io/setup/bakery/.
repeated baseImages = 2
List of configured base images.
string zone = 3
The default zone in which to bake an image.
string network = 4
The Google Compute network ID or URL to use for the launched instance. Defaults to default.
optional useInternalIp = 5
If true, use the instance's internal IP instead of its external IP during baking.
string networkProjectId = 6
The default project ID for the network and subnet to use for the VM baking your image.
message
google.proto:117Base image configuration.
Used in:
string id = 1
This is the identifier used by GCP to find this base image.
string shortDescription = 2
A short description to help human operators identify the image.
string detailedDescription = 3
A long description to help human operators identify the image.
string packageType = 4
This is used to help Spinnaker's bakery download the build artifacts you supply it with. For example, specifying deb indicates that your artifacts will need to be fetched from a debian repository.
optional imageFamily = 5
If set to true, Deck will annotate the popup tooltip to indicate that the selected option represents an image family.
message
google.proto:108Configuration for a base image for the Google provider's bakery.
Used in:
optional baseImage = 1
Base image configuration.
optional virtualizationSettings = 2
Image source configuration.
message
google.proto:11Configuration for the Google Compute Engine (GCE) provider.
Used in: , ,
optional enabled = 1
Whether the provider is enabled.
repeated accounts = 2
The list of configured accounts.
string primaryAccount = 3
The name of the primary account.
optional bakeryDefaults = 4
Configuration for Spinnaker's image bakery.
message
google.proto:27Configuration for a Spinnaker Google account. An account maps to a credential that can authenticate against a GCP project.
Used in:
string name = 1
The name of the account.
repeated string requiredGroupMembership = 3
(Deprecated): List of required Fiat permission groups. Configure `permissions` instead.
optional permissions = 4
Fiat permissions configuration.
string project = 5
The GCP project this Spinnaker account will manage.
string jsonPath = 6
The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
optional alphaListed = 7
Enable this flag if your GCP project has access to alpha features and you want Spinnaker to take advantage of them.
repeated string imageProjects = 8
A list of GCP projects from which Spinnaker will be able to cache and deploy images. When this is omitted, it defaults to the current project. Each project must have granted the IAM role compute.imageUser to the service account associated with the JSON key used by this account, as well as to the Google APIs service account automatically created for the project being managed (should look similar to 12345678912@cloudservices.gserviceaccount.com). See https://cloud.google.com/compute/docs/images/sharing-images-across-projects for more information about sharing images across GCP projects.
optional consul = 9
Configuration for Consul.
repeated string regions = 10
A list of regions for caching and mutating calls. This overwrites any default regions set on the provider.
string userDataFile = 11
The path to user data template file. Spinnaker has the ability to inject userdata into generated instance templates. The mechanism is via a template file that is token replaced to provide some specifics about the deployment. See https://github.com/spinnaker/clouddriver/blob/master/clouddriver-aws/UserData.md for more information.
message
huaweicloud.proto:11Configuration for the Huawei Cloud provider.
Used in: , ,
optional enabled = 1
Whether the provider is enabled.
repeated accounts = 2
The list of configured accounts.
string primaryAccount = 3
The name of the primary account.
optional bakeryDefaults = 4
Configuration for Spinnaker's image bakery.
message
huaweicloud.proto:26Configuration for a Huawei Cloud account.
Used in:
string name = 1
The name of the account.
string accountType = 2
The type of account.
repeated string requiredGroupMembership = 3
(Deprecated) List of required Fiat permission groups. Configure `permissions` instead.
optional permissions = 4
Fiat permissions configuration.
string authUrl = 5
(Required) The auth URL of the cloud.
string domainName = 6
(Required) The domain name of the cloud.
string environment = 7
The environment name for the account. Many accounts can share the same environment (e.g., dev, test, prod).
optional insecure = 8
If `true`, disables certificate validation on SSL connections. Needed if certificates are self-signed. Defaults to `false`.
string password = 9
(Required) The password used to access the cloud.
string projectName = 10
(Required) The name of the project within the cloud.
repeated string regions = 11
(Required) The region(s) of the cloud.
string username = 12
(Required) The username used to access the cloud.
message
huaweicloud.proto:68Configuration for Spinnaker's image bakery.
Used in:
repeated baseImages = 1
List of configured base images.
string templateFile = 2
This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list: https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer, or supplied as described here: https://spinnaker.io/setup/bakery/.
string authUrl = 3
(Required) The default auth URL in which images will be baked.
string username = 4
(Required) The default username with which images will be baked.
string password = 5
(Required) The default password with which images will be baked.
string projectName = 6
The name of the default project in which images will be baked.
string domainName = 7
(Required) The default domain name in which images will be baked.
optional insecure = 8
The security setting for connecting to the Huawei Cloud account. Defaults to `false`.
string vpcId = 9
(Required) The VPC in which images will be baked.
string subnetId = 10
(Required) The subnet in which images will be baked.
string securityGroup = 11
(Required) The default security group in which images will be baked.
int32 eipBandwidthSize = 12
(Required) The bandwidth size of EIP in which images will be baked.
message
huaweicloud.proto:120Huawei Cloud base image settings.
Used in:
string id = 1
The name of the base image.
string packageType = 2
This is used to help Spinnaker's bakery download the build artifacts you supply it with. For example, specifying `deb` indicates that your artifacts will need to be fetched from a debian repository.
string templateFile = 3
This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list: https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer, or supplied as described here: https://spinnaker.io/setup/bakery/.
string shortDescription = 4
A short description to help human operators identify the image.
string detailedDescription = 5
A long description to help human operators identify the image.
message
huaweicloud.proto:111Configuration for a base image for the Huawei Cloud provider's bakery.
Used in:
optional baseImage = 1
Base image configuration.
repeated virtualizationSettings = 2
Image source configuration.
message
huaweicloud.proto:145Huawei Cloud virtualization settings.
Used in:
string region = 1
(Required) The region for the baking configuration.
string instanceType = 2
(Required) The instance type for the baking configuration.
string sourceImageId = 3
(Required) The source image ID for the baking configuration.
string sshUserName = 4
(Required) The SSH username for the baking configuration.
string eipType = 5
(Required) The EIP type for the baking configuration. See the API doc to get its value.
message
kubernetes.proto:11Configuration for the Kubernetes provider.
Used in: ,
optional enabled = 1
Whether the provider is enabled.
repeated accounts = 2
The list of configured accounts.
string primaryAccount = 3
The name of the primary account.
message
kubernetes.proto:24Configuration for a Spinnaker Kubernetes account. An account maps to a credential that can authenticate against your Kubernetes cluster.
Used in:
string name = 1
The name of the account.
repeated string kinds = 3
A list of resource kinds this Spinnaker account can deploy and will cache. When no kinds are configured, this defaults to all kinds described here: https://spinnaker.io/reference/providers/kubernetes-v2/. This can only be set when omitKinds is empty or not set.
repeated string omitKinds = 4
A list of resource kinds this Spinnaker account cannot deploy to or cache. This can only be set when kinds is empty or not set.
string context = 5
The kubernetes context to be managed by Spinnaker. See http://kubernetes.io/docs/user-guide/kubeconfig-file/#context for more information. When no context is configured for an account the `current-context` in your kubeconfig is assumed.
int32 cacheThreads = 6
Number of caching agents for this kubernetes account. Each agent handles a subset of the namespaces available to this account. By default, only 1 agent caches all kinds for all namespaces in the account.
repeated string namespaces = 7
A list of namespaces this Spinnaker account can deploy to and will cache. When no namespaces are configured, this defaults to all namespaces.
repeated string omitNamespaces = 8
A list of namespaces this Spinnaker account cannot deploy to or cache. This can only be set when namespaces is empty or not set.
repeated customResources = 9
The list of custom resources Clouddriver will manage and make available for use in Patch and Delete (Manifest) stages.
repeated cachingPolicies = 10
The list of kind-specific caching policies.
repeated dockerRegistries = 11
The list of the Spinnaker docker registry account names this Spinnaker account can use as image sources. These docker registry accounts must be registered in your halconfig before you can add them here.
repeated string oAuthScopes = 12
The list of OAuth scopes used by kubectl to fetch an OAuth token.
string kubeconfigFile = 13
The path to your kubeconfig file. By default, it will be under the Spinnaker user's home directory in the typical .kube/config location.
optional permissions = 14
Fiat permissions configuration.
repeated string requiredGroupMembership = 15
(Deprecated): List of required Fiat permission groups. Configure `permissions` instead.
optional liveManifestCalls = 16
When true, clouddriver will query manifest status during pipeline executions using live data rather than the cache. This eliminates all time spent in the "force cache refresh" task in pipelines, greatly reducing execution time. Defaults to false.
optional serviceAccount = 17
When true, Spinnaker attempt to authenticate against Kubernetes using a Kubernetes service account. This only works when Halyard & Spinnaker are deployed in Kubernetes. Read more about service accounts here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/. Defaults to false.
string kubeconfigContents = 18
The raw contents of your kubeconfig file. Ignored if kubeconfigFile is set.
string kubectlPath = 19
The path to the kubectl executable. This should be omitted unless you want to override the default kubectl exectuable.
int32 kubectlRequestTimeoutSeconds = 22
If set, all calls to kubectl will time out after the specified number of seconds.
optional checkPermissionsOnStartup = 23
Whether to check whether the account has permission to read configured kinds before caching them. Kinds that the account does not have permission to read will be omitted from caching. This field defaults to true, and it is recommended to leave it at the default. If this field is set to false, any Kubernetes objects that are unreadable by the account will break caching for all objects.
string oAuthServiceAccount = 24
When using OAuth to authenticate with your cluster, the name of the service account to use.
optional onlySpinnakerManaged = 27
If true, only cache Kubernetes objects that have been deployed by Spinnaker, and ignore any other objects that exist in the cluster. Defaults to false.
optional debug = 28
If true, enable detailed logging for all communications with the Kubernetes cluster for this account. Defaults to false.
message
kubernetes.proto:167Configuration for a Docker registry.
Used in:
string accountName = 1
The configured name of the Docker registry.
repeated string namespaces = 2
The list of Docker registry namespaces usable as image sources.
message
kubernetes.proto:157Configuration for a kind-specific caching policy.
Used in:
string kubernetesKind = 1
The Kubernetes kind to which the policy applies.
int32 maxEntriesPerAgent = 2
The maximum number of resources an agent will cache of the specified Kubernetes kind.
message
kubernetes.proto:136Configuration for a CRD to be managed by Spinnaker. If Spinnaker does not have permission to list CRDs but you need Spinnaker to manage CRDs, you need to explicitly register each CRD.
Used in:
string kubernetesKind = 1
The Kubernetes kind of the custom resource.
string spinnakerKind = 2
The Spinnaker kind to which you would like the custom resource to map.
string deployPriority = 3
An integer representing the deployment priority of this resource. Resources with lower values are deployed before resources with higher values.
optional versioned = 4
Whether Spinnaker should manage versioning this resource.
optional namespaced = 5
Whether the resource is namespaced. Defaults to true.
message
oracle.proto:11Configuration for the Oracle provider.
Used in: , ,
optional enabled = 1
Whether the provider is enabled.
repeated accounts = 2
The list of configured accounts.
string primaryAccount = 3
The name of the primary account.
optional bakeryDefaults = 4
Configuration for Spinnaker's image bakery.
message
oracle.proto:27Configuration for an Oracle account. An account maps to an Oracle Cloud Infrastructure (OCI) user.
Used in:
string name = 1
The name of the account.
repeated string requiredGroupMembership = 2
(Deprecated) List of required Fiat permission groups. Configure `permissions` instead.
optional permissions = 3
Fiat permissions configuration.
string compartmentId = 4
(Required) The OCID of the Oracle Compartment to use.
string environment = 5
The environment name for the account. Many accounts can share the same environment (e.g., dev, test, prod).
string fingerprint = 6
(Required) Fingerprint of the public key.
string privateKeyPassphrase = 7
Passphrase used for the private key, if it is encrypted.
string region = 8
(Required) An Oracle region (e.g., `us-phoenix-1`).
string sshPrivateKeyFilePath = 9
(Required) Path to the private key in PEM format.
string tenancyId = 10
(Required) The OCID of the Oracle Tenancy to use.
string userId = 11
(Required) The OCID of the Oracle User with which to authenticate.
message
oracle.proto:65Configuration for Spinnaker's image bakery.
Used in:
string templateFile = 1
The name of the Packer template that will be used to bake images from this base image. The template file must be found in this list: https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer, or supplied as described here: https://spinnaker.io/setup/bakery/.
repeated baseImages = 2
List of configured base images.
string availabilityDomain = 3
(Required) The name of the Availability Domain within which a new instance is launched and provisioned.
string instanceShape = 4
(Required) The shape for a newly created instance.
string subnetId = 5
(Required) The name of the subnet within which a new instance is launched and provisioned.
message
oracle.proto:97Oracle base image configuration.
Used in:
string id = 1
The name of the base image.
string shortDescription = 2
A short description to help human operators identify the image.
string detailedDescription = 3
A long description to help human operators identify the image.
string packageType = 4
This is used to help Spinnaker's bakery download the build artifacts you supply it with. For example, specifying deb indicates that your artifacts will need to be fetched from a debian repository.
string templateFile = 5
The name of the Packer template that will be used to bake images from this base image. The template file must be found in this list: https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer, or supplied as described here: https://spinnaker.io/setup/bakery/.
message
oracle.proto:88Configuration for a base image for the Oracle provider's bakery.
Used in:
optional baseImage = 1
Oracle base image configuration.
optional virtualizationSettings = 2
Oracle virtualization settings.
message
oracle.proto:123Oracle virtualization settings.
Used in:
string baseImageId = 1
(Required) The OCID of the base image ID for the baking configuration.
string sshUserName = 2
(Required) The ssh username for the baking configuration.
message
providers.proto:19Configuration for cloud provider integrations.
Used in:
optional kubernetes = 1
optional google = 2
optional appengine = 3
optional aws = 4
optional azure = 5
optional cloudfoundry = 6
optional dcos = 7
optional dockerRegistry = 8
optional ecs = 9
optional huaweicloud = 10
optional oracle = 11
message
google.proto:142Image source configuration.
Used in:
string sourceImage = 1
The source image. If both sourceImage and sourceImageFamily are set, sourceImage will take precedence.
string sourceImageFamily = 2
The source image family to create the image from. The newest, non-deprecated image is used. If both sourceImage and sourceImageFamily are set, sourceImage will take precedence.