cloud-mu 3.1.2beta2 → 3.1.2

data/modules/mu/mu.yaml.rb

@@ -1,282 +0,0 @@
-# Configuration schema for mu.yaml. See also {https://github.com/cloudamatic/mu/wiki/Configuration the Mu wiki}.
-#
-# Example:
-#
-# <pre>
-#      ---    
-#      public_address: 1.2.3.4    
-#      mu_admin_email: egtlabs@eglobaltech.com    
-#      mu_admin_name: Joe Schmoe    
-#      mommacat_port: 2260    
-#      banner: My Example Mu Master    
-#      mu_repository: git://github.com/cloudamatic/mu.git    
-#      repos:    
-#      - https://github.com/cloudamatic/mu_demo_platform    
-#      allow_invade_foreign_vpcs: true    
-#      ansible_dir:    
-#      aws:    
-#        egtdev:    
-#          region: us-east-1    
-#          log_bucket_name: egt-mu-log-bucket    
-#          default: true    
-#          name: egtdev    
-#        personal:    
-#          region: us-east-2    
-#          log_bucket_name: my-mu-log-bucket    
-#          name: personal    
-#        google:    
-#          egtlabs:    
-#            project: egt-labs-admin    
-#            credentials_file: /opt/mu/etc/google.json    
-#            region: us-east4    
-#            log_bucket_name: hexabucket-761234    
-#            default: true    
-# </pre>
-module MuYAML
-	# The configuration file format for Mu's main config file.
-	# Amazon Web Services
-	class aws
-		# @!group Required parameters
-		
-		# **REQUIRED** - 
-		# S3 bucket into which we'll synchronize deploy secrets, and if we're hosted in AWS, collected system logs
-		#
-		# @return [String]
-		attr_accessor :log_bucket_name
-		# @!endgroup
-		# @!group Optional parameters
-		
-		# **Must match pattern `(?i-mx:^[a-z0-9]+$)`** - 
-		# Credentials used for accessing the AWS API (looks like: AKIAINWLOOAA24PBRBZA)
-		#
-		# @return [String]
-		attr_accessor :access_key
-		
-		# Credentials used for accessing the AWS API (looks like: +Z16iRP9QAq7EcjHINyEMs3oR7A76QpfaSgCBogp).
-		#
-		# @return [String]
-		attr_accessor :access_secret
-		
-		# **Must match pattern `(?-mix:^\d+$)`** - 
-		# Default target account for resources managed using these credentials. This is an AWS account number, e.g. 918972669773. If not specified, we will use the account number which owns these API keys.
-		#
-		# @return [String]
-		attr_accessor :account_number
-		
-		# A secure Chef vault and item from which to retrieve an AWS access key and secret. The vault item should have 'access_key' and 'access_secret' elements.
-		#
-		# @return [String]
-		attr_accessor :credentials
-		
-		# An INI-formatted AWS credentials file, of the type used by the AWS command-line tools. This is less secure than using 'credentials' to store these in a Chef vault. See: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html
-		#
-		# @return [String]
-		attr_accessor :credentials_file
-		
-		# **Default: `false`** - 
-		# If set to true, Mu will default to these AWS credentials when targeting AWS resources
-		#
-		# @return [Boolean]
-		attr_accessor :default
-		
-		# Default Amazon Web Services region in which these credentials should operate
-		#
-		# @return [String]
-		attr_accessor :region
-		# @!endgroup
-	end
-	# Microsoft Azure Cloud Computing Platform & Services
-	class azure
-		# @!group Optional parameters
-		
-		# App client id used to authenticate to our subscription. From https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredAppsPreview
-		#
-		# @return [String]
-		attr_accessor :client_id
-		
-		# App client secret used to authenticate to our subscription. From https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredAppsPreview under the 'Certificates & secrets' tab, 'Client secrets.' This can only be retrieved upon initial secret creation.
-		#
-		# @return [String]
-		attr_accessor :client_secret
-		
-		# JSON file which contains a hash of directory_id, client_id, client_secret, and subscription values. If found, these will be override values entered directly in mu-configure.
-		#
-		# @return [String]
-		attr_accessor :credentials_file
-		
-		# **Default: `false`** - 
-		# If set to true, Mu will use this set of Azure credentials when targeting Azure without a specific account having been requested
-		#
-		# @return [Boolean]
-		attr_accessor :default
-		
-		# AKA Tenant ID; the default Microsoft Azure Directory project in which we operate and deploy, from https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredAppsPreview
-		#
-		# @return [String]
-		attr_accessor :directory_id
-		
-		# **Default: `eastus`** - 
-		# Default Microsoft Azure region in which we operate and deploy
-		#
-		# @return [String]
-		attr_accessor :region
-		
-		# Default Microsoft Azure Subscription we will use to deploy, from https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade
-		#
-		# @return [String]
-		attr_accessor :subscription
-		# @!endgroup
-	end
-	# Google Cloud Platform
-	class google
-		# @!group Required parameters
-		
-		# **REQUIRED** - 
-		# Cloud Storage bucket into which we'll synchronize deploy secrets, and if we're hosted in GCP, collected system logs
-		#
-		# @return [String]
-		attr_accessor :log_bucket_name
-		
-		# **REQUIRED** - 
-		# Default Google Cloud Platform project in which we operate and deploy. Generate a service account at: https://console.cloud.google.com/iam-admin/serviceaccounts/project, making sure the account has sufficient privileges to manage cloud resources. Download the private key as JSON, and import that key to the vault specified here. Import example: knife vault create secrets google -J my-google-service-account.json
-		#
-		# @return [String]
-		attr_accessor :project
-		# @!endgroup
-		# @!group Optional parameters
-		
-		# A secure Chef vault and item from which to retrieve the JSON-formatted Service Account credentials for our GCP account, in the format vault:itemname (e.g. 'secrets:google'). Generate a service account at: https://console.cloud.google.com/iam-admin/serviceaccounts/project, making sure the account has sufficient privileges to manage cloud resources. Download the private key as JSON, and import that key to the vault specified here. Import example: knife vault create secrets google -J my-google-service-account.json 
-		#
-		# @return [String]
-		attr_accessor :credentials
-		
-		# JSON-formatted Service Account credentials for our GCP account, b64-encoded and dropped directly into mu.yaml. Generate a service account at: https://console.cloud.google.com/iam-admin/serviceaccounts/project, making sure the account has sufficient privileges to manage cloud resources. Download the private key as JSON and point this argument to the file. This is less secure than using 'credentials' to store in a vault.
-		#
-		# @return [String]
-		attr_accessor :credentials_encoded
-		
-		# JSON-formatted Service Account credentials for our GCP account, stored in plain text in a file. Generate a service account at: https://console.cloud.google.com/iam-admin/serviceaccounts/project, making sure the account has sufficient privileges to manage cloud resources. Download the private key as JSON and point this argument to the file. This is less secure than using 'credentials' to store in a vault.
-		#
-		# @return [String]
-		attr_accessor :credentials_file
-		
-		# For Google Cloud projects which are attached to a GSuite domain. Some API calls (groups, users, etc) require this identifier. From admin.google.com, choose Security, the Single Sign On, and look for the Entity ID field. The value after idpid= in the URL there should be the customer ID.
-		#
-		# @return [String]
-		attr_accessor :customer_id
-		
-		# **Default: `false`** - 
-		# If set to true, Mu will use this set of GCP credentials when targeting the Google Cloud without a specific account having been requested
-		#
-		# @return [Boolean]
-		attr_accessor :default
-		
-		# For Google Cloud projects which are attached to a GSuite domain. GCP service accounts cannot view or manage GSuite resources (groups, users, etc) directly, but must instead masquerade as a GSuite user which has delegated authority to the service account. See also: https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority
-		#
-		# @return [String]
-		attr_accessor :masequerade_as
-		
-		# **Default: `us-east4`** - 
-		# Default Google Cloud Platform region in which we operate and deploy
-		#
-		# @return [String]
-		attr_accessor :region
-		# @!endgroup
-	end
-	# @!group Required parameters
-	
-	# **REQUIRED**,
-	# **Must match pattern `(?i-mx:^[a-z0-9\-_]+$)`** - 
-	# The local system's value for HOSTNAME
-	#
-	# @return [String]
-	attr_accessor :hostname
-	
-	# **REQUIRED**,
-	# **Must match pattern `(?i-mx:\A([\w+\-].?)+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z)`** - 
-	# Administative contact email
-	#
-	# @return [String]
-	attr_accessor :mu_admin_email
-	
-	# **REQUIRED**,
-	# **Must match pattern `(?-mix:^(127\.0\.0\.1|localhost)$)`** - 
-	# IP address or hostname
-	#
-	# @return [String]
-	attr_accessor :public_address
-	# @!endgroup
-	# @!group Optional parameters
-	
-	# If set to true, Mu will be allowed to modify routing and peering behavior of VPCs which it did not create, but for which it has permissions.
-	#
-	# @return [Boolean]
-	attr_accessor :allow_invade_foreign_vpcs
-	
-	# Intended for use with minimal installs which use Ansible as a groomer and which do not store Ansible artifacts in a dedicated git repository. This allows simply pointing to a local directory.
-	#
-	# @return [String]
-	attr_accessor :ansible_dir
-	
-	# Amazon Web Services
-	#
-	# @return [aws]
-	# @see aws
-	attr_accessor :aws
-	
-	# Microsoft Azure Cloud Computing Platform & Services
-	#
-	# @return [azure]
-	# @see azure
-	attr_accessor :azure
-	
-	# Login banner, displayed in various locations
-	#
-	# @return [String]
-	attr_accessor :banner
-	
-	# **Default: `false`** - 
-	# Disable the Momma Cat grooming daemon. Nodes which require asynchronous Ansible/Chef bootstraps will not function. This option is only honored in gem-based installations.
-	#
-	# @return [Boolean]
-	attr_accessor :disable_mommacat
-	
-	# Google Cloud Platform
-	#
-	# @return [google]
-	# @see google
-	attr_accessor :google
-	
-	# Optional extra Chef roles or recipes to invoke when running chef-client on this Master (ex: recipe[mycookbook::mumaster])
-	#
-	# @return [Array<String>]
-	attr_accessor :master_runlist_extras
-	
-	# **Default: `2260`**,
-	# **Must match pattern `(?i-mx:^[0-9]+$)`** - 
-	# Listen port for the Momma Cat grooming daemon
-	#
-	# @return [String]
-	attr_accessor :mommacat_port
-	
-	# **Default: `Mu Administrator`** - 
-	# Administative contact's full name
-	#
-	# @return [String]
-	attr_accessor :mu_admin_name
-	
-	# **Default: `git://github.com/cloudamatic/mu.git`**,
-	# **Must match pattern `(?-mix:(((git|ssh|http(s)?)|(git@[\w\.]+))(:(\/\/)?))?([\w\.@\:\/\-~]+)(\.git)?(\/)?)`** - 
-	# Source repository for Mu tools
-	#
-	# @return [String]
-	attr_accessor :mu_repository
-	
-	# **Default: `["https://github.com/cloudamatic/mu_demo_platform"]`**,
-	# **Must match pattern `(?-mix:(((git|ssh|http(s)?)|(git@[\w\.]+))(:(\/\/)?))?([\w\.@\:\/\-~]+)(\.git)?(\/)?)`** - 
-	# Optional platform repositories, as a Git URL or Github repo name (ex: eGT-Labs/fema_platform.git)
-	#
-	# @return [Array<String>]
-	attr_accessor :repos
-	# @!endgroup
-end