From 85ef23a859df9f9e953e7a3d60a991d9abe7eda3 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Sun, 22 Jul 2018 15:33:17 -0700 Subject: [PATCH] Documentation/variables: Drop stale docs These used to be generated with terraform-docs, but the associated Makefile rule was removed without replacement in d61abd48 (*: cleanup bazel rules, 2018-03-26, coreos/tectonic-installer#3137). terraform-examples seems to have been similar, and its last Makefile reference was also removed in d61abd48. We may want to return to autogenerating examples/*.yaml at some point, but for now, stop claiming that we are autogenerating these. --- CONTRIBUTING.md | 5 ---- Documentation/variables/aws.md | 44 ------------------------------- Documentation/variables/config.md | 40 ---------------------------- 3 files changed, 89 deletions(-) delete mode 100644 Documentation/variables/aws.md delete mode 100644 Documentation/variables/config.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 88f64a0a5ab..1774b9d1e7d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,11 +36,6 @@ Due to their public nature, GitHub and mailing lists are not appropriate places - Fork the repository on GitHub - Read the [README](README.md) for build and test instructions - Play with the project, submit bugs, submit patches! -- Go get a couple of projects nesessary for updating docs and examples: - ```sh - go get github.com/segmentio/terraform-docs - go get github.com/openshift/installer/contrib/terraform-examples - ``` ### Contribution Flow diff --git a/Documentation/variables/aws.md b/Documentation/variables/aws.md deleted file mode 100644 index a673d23e1db..00000000000 --- a/Documentation/variables/aws.md +++ /dev/null @@ -1,44 +0,0 @@ - -# Terraform variables -This document gives an overview of variables used in the AWS platform of the Tectonic SDK. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| tectonic_autoscaling_group_extra_tags | (optional) Extra AWS tags to be applied to created autoscaling group resources. This is a list of maps having the keys `key`, `value` and `propagate_at_launch`.

Example: `[ { key = "foo", value = "bar", propagate_at_launch = true } ]` | list | `` | no | -| tectonic_aws_config_version | (internal) This declares the version of the AWS configuration variables. It has no impact on generated assets but declares the version contract of the configuration. | string | `1.0` | no | -| tectonic_aws_ec2_ami_override | (optional) AMI override for all nodes. Example: `ami-foobar123`. | string | `` | no | -| tectonic_aws_endpoints | (optional) If set to "all", the default, then both public and private ingress resources (ELB, A-records) will be created. If set to "private", then only create private-facing ingress resources (ELB, A-records). No public-facing ingress resources will be created. If set to "public", then only create public-facing ingress resources (ELB, A-records). No private-facing ingress resources will be provisioned and all DNS records will be created in the public Route53 zone. | string | - | yes | -| tectonic_aws_etcd_ec2_type | Instance size for the etcd node(s). Example: `t2.medium`. Read the [etcd recommended hardware](https://coreos.com/etcd/docs/latest/op-guide/hardware.html) guide for best performance | string | `t2.medium` | no | -| tectonic_aws_etcd_extra_sg_ids | (optional) List of additional security group IDs for etcd nodes.

Example: `["sg-51530134", "sg-b253d7cc"]` | list | `` | no | -| tectonic_aws_etcd_iam_role_name | (optional) Name of IAM role to use for the instance profiles of etcd nodes. The name is also the last part of a role's ARN.

Example: * Role ARN = arn:aws:iam::123456789012:role/tectonic-installer * Role Name = tectonic-installer | string | `` | no | -| tectonic_aws_etcd_root_volume_iops | The amount of provisioned IOPS for the root block device of etcd nodes. Ignored if the volume type is not io1. | string | `100` | no | -| tectonic_aws_etcd_root_volume_size | The size of the volume in gigabytes for the root block device of etcd nodes. | string | `30` | no | -| tectonic_aws_etcd_root_volume_type | The type of volume for the root block device of etcd nodes. | string | `gp2` | no | -| tectonic_aws_external_master_subnet_ids | (optional) List of subnet IDs within an existing VPC to deploy master nodes into. Required to use an existing VPC, not applicable otherwise.

Example: `["subnet-111111", "subnet-222222", "subnet-333333"]` | list | `` | no | -| tectonic_aws_external_private_zone | (optional) If set, the given Route53 zone ID will be used as the internal (private) zone. This zone will be used to create etcd DNS records as well as internal API and internal Ingress records. If set, no additional private zone will be created.

Example: `"Z1ILINNUJGTAO1"` | string | `` | no | -| tectonic_aws_external_vpc_id | (optional) ID of an existing VPC to launch nodes into. If unset a new VPC is created.

Example: `vpc-123456` | string | `` | no | -| tectonic_aws_external_worker_subnet_ids | (optional) List of subnet IDs within an existing VPC to deploy worker nodes into. Required to use an existing VPC, not applicable otherwise.

Example: `["subnet-111111", "subnet-222222", "subnet-333333"]` | list | `` | no | -| tectonic_aws_extra_tags | (optional) Extra AWS tags to be applied to created resources.

Example: `{ "key" = "value", "foo" = "bar" }` | map | `` | no | -| tectonic_aws_installer_role | (optional) Name of IAM role to use to access AWS in order to deploy the Tectonic Cluster. The name is also the full role's ARN.

Example: * Role ARN = arn:aws:iam::123456789012:role/tectonic-installer | string | `` | no | -| tectonic_aws_master_custom_subnets | (optional) This configures master availability zones and their corresponding subnet CIDRs directly.

Example: `{ eu-west-1a = "10.0.0.0/20", eu-west-1b = "10.0.16.0/20" }` | map | `` | no | -| tectonic_aws_master_ec2_type | Instance size for the master node(s). Example: `t2.medium`. | string | `t2.medium` | no | -| tectonic_aws_master_extra_sg_ids | (optional) List of additional security group IDs for master nodes.

Example: `["sg-51530134", "sg-b253d7cc"]` | list | `` | no | -| tectonic_aws_master_iam_role_name | (optional) Name of IAM role to use for the instance profiles of master nodes. The name is also the last part of a role's ARN.

Example: * Role ARN = arn:aws:iam::123456789012:role/tectonic-installer * Role Name = tectonic-installer | string | `` | no | -| tectonic_aws_master_root_volume_iops | The amount of provisioned IOPS for the root block device of master nodes. Ignored if the volume type is not io1. | string | `100` | no | -| tectonic_aws_master_root_volume_size | The size of the volume in gigabytes for the root block device of master nodes. | string | `30` | no | -| tectonic_aws_master_root_volume_type | The type of volume for the root block device of master nodes. | string | `gp2` | no | -| tectonic_aws_profile | (optional) This declares the AWS credentials profile to use. | string | - | yes | -| tectonic_aws_region | The target AWS region for the cluster. | string | - | yes | -| tectonic_aws_ssh_key | Name of an SSH key located within the AWS region. Example: coreos-user. | string | - | yes | -| tectonic_aws_vpc_cidr_block | Block of IP addresses used by the VPC. This should not overlap with any other networks, such as a private datacenter connected via Direct Connect. | string | - | yes | -| tectonic_aws_worker_custom_subnets | (optional) This configures worker availability zones and their corresponding subnet CIDRs directly.

Example: `{ eu-west-1a = "10.0.64.0/20", eu-west-1b = "10.0.80.0/20" }` | map | `` | no | -| tectonic_aws_worker_ec2_type | Instance size for the worker node(s). Example: `t2.medium`. | string | `t2.medium` | no | -| tectonic_aws_worker_extra_sg_ids | (optional) List of additional security group IDs for worker nodes.

Example: `["sg-51530134", "sg-b253d7cc"]` | list | `` | no | -| tectonic_aws_worker_iam_role_name | (optional) Name of IAM role to use for the instance profiles of worker nodes. The name is also the last part of a role's ARN.

Example: * Role ARN = arn:aws:iam::123456789012:role/tectonic-installer * Role Name = tectonic-installer | string | `` | no | -| tectonic_aws_worker_load_balancers | (optional) List of ELBs to attach all worker instances to. This is useful for exposing NodePort services via load-balancers managed separately from the cluster.

Example: * `["ingress-nginx"]` | list | `` | no | -| tectonic_aws_worker_root_volume_iops | The amount of provisioned IOPS for the root block device of worker nodes. Ignored if the volume type is not io1. | string | `100` | no | -| tectonic_aws_worker_root_volume_size | The size of the volume in gigabytes for the root block device of worker nodes. | string | `30` | no | -| tectonic_aws_worker_root_volume_type | The type of volume for the root block device of worker nodes. | string | `gp2` | no | - diff --git a/Documentation/variables/config.md b/Documentation/variables/config.md deleted file mode 100644 index 0b2e3992fc3..00000000000 --- a/Documentation/variables/config.md +++ /dev/null @@ -1,40 +0,0 @@ - -# Terraform variables -This document gives an overview of variables used in all platforms of the Tectonic SDK. - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| tectonic_admin_email | (internal) The e-mail address used to: 1. login as the admin user to the Tectonic Console. 2. generate DNS zones for some providers.

Note: This field MUST be in all lower-case e-mail address format and set manually prior to creating the cluster. | string | - | yes | -| tectonic_admin_password | (internal) The admin user password to login to the Tectonic Console.

Note: This field MUST be set manually prior to creating the cluster. Backslashes and double quotes must also be escaped. | string | - | yes | -| tectonic_base_domain | The base DNS domain of the cluster. It must NOT contain a trailing period. Some DNS providers will automatically add this if necessary.

Example: `openshift.example.com`.

Note: This field MUST be set manually prior to creating the cluster. This applies only to cloud platforms. | string | - | yes | -| tectonic_ca_cert | (optional) The content of the PEM-encoded CA certificate, used to generate all cluster certificates. If left blank, a CA certificate will be automatically generated. | string | `` | no | -| tectonic_ca_key | (optional) The content of the PEM-encoded CA key, used to generate Tectonic all cluster certificates. This field is mandatory if `tectonic_ca_cert` is set. | string | `` | no | -| tectonic_ca_key_alg | (optional) The algorithm used to generate tectonic_ca_key. The default value is currently recommended. This field is mandatory if `tectonic_ca_cert` is set. | string | `RSA` | no | -| tectonic_cluster_cidr | (optional) This declares the IP range to assign Kubernetes pod IPs in CIDR notation. | string | - | yes | -| tectonic_cluster_id | (internal) The Tectonic cluster id. | string | - | yes | -| tectonic_cluster_name | The name of the cluster. If used in a cloud-environment, this will be prepended to `tectonic_base_domain` resulting in the URL to the Tectonic console.

Note: This field MUST be set manually prior to creating the cluster. | string | - | yes | -| tectonic_config_version | (internal) This declares the version of the global configuration variables. It has no impact on generated assets but declares the version contract of the configuration. | string | `1.0` | no | -| tectonic_container_base_images | (internal) Base images of the components to use | map | `` | no | -| tectonic_container_images | (internal) Container images to use | map | `` | no | -| tectonic_container_linux_channel | The Container Linux update channel.

Examples: `stable`, `beta`, `alpha` | string | - | yes | -| tectonic_container_linux_version | The Container Linux version to use. Set to `latest` to select the latest available version for the selected update channel.

Examples: `latest`, `1465.6.0` | string | - | yes | -| tectonic_etcd_count | The number of etcd nodes to be created. If set to zero, the count of etcd nodes will be determined automatically. | string | `0` | no | -| tectonic_ignition_master | (internal) Ignition config file path. This is automatically generated by the installer. | string | `` | no | -| tectonic_ignition_worker | (internal) Ignition config file path. This is automatically generated by the installer. | string | `` | no | -| tectonic_image_re | (internal) Regular expression used to extract repo and tag components | string | `/^([^/]+/[^/]+):(.*)$/` | no | -| tectonic_kubelet_debug_config | (internal) debug flags for the kubelet (used in CI only) | string | `` | no | -| tectonic_license_path | The path to the tectonic licence file. You can download the Tectonic license file from your Account overview page at [1].

[1] https://account.coreos.com/overview | string | `` | no | -| tectonic_master_count | The number of master nodes to be created. This applies only to cloud platforms. | string | `1` | no | -| tectonic_networking | (optional) Configures the network to be used in Tectonic. One of the following values can be used:

- "flannel": enables overlay networking only. This is implemented by flannel using VXLAN.

- "canal": enables overlay networking including network policy. Overlay is implemented by flannel using VXLAN. Network policy is implemented by Calico.

- "calico-ipip": [ALPHA] enables BGP based networking. Routing and network policy is implemented by Calico. Note this has been tested on bare metal installations only.

- "none": disables the installation of any Pod level networking layer provided by Tectonic. By setting this value, users are expected to deploy their own solution to enable network connectivity for Pods and Services. | string | - | yes | -| tectonic_platform | (internal) The internal Terraform platform type, e.g. aws or libvirt | string | - | yes | -| tectonic_pull_secret_path | The path the pull secret file in JSON format. This is known to be a "Docker pull secret" as produced by the docker login [1] command. A sample JSON content is shown in [2]. You can download the pull secret from your Account overview page at [3].

[1] https://docs.docker.com/engine/reference/commandline/login/

[2] https://coreos.com/os/docs/latest/registry-authentication.html#manual-registry-auth-setup

[3] https://account.coreos.com/overview | string | `` | no | -| tectonic_service_cidr | (optional) This declares the IP range to assign Kubernetes service cluster IPs in CIDR notation. The maximum size of this IP range is /12 | string | - | yes | -| tectonic_stats_url | (internal) The Tectonic statistics collection URL to which to report. | string | `https://stats-collector.tectonic.com` | no | -| tectonic_update_app_id | (internal) The Tectonic Omaha update App ID | string | `6bc7b986-4654-4a0f-94b3-84ce6feb1db4` | no | -| tectonic_update_channel | (internal) The Tectonic Omaha update channel | string | `tectonic-1.9-production` | no | -| tectonic_update_server | (internal) The URL of the Tectonic Omaha update server | string | `https://tectonic.update.core-os.net` | no | -| tectonic_versions | (internal) Versions of the components to use | map | `` | no | -| tectonic_worker_count | The number of worker nodes to be created. This applies only to cloud platforms. | string | `3` | no | -