Skip to content
This repository has been archived by the owner on Jun 29, 2022. It is now read-only.

Commit

Permalink
Add Type column in Attribute reference
Browse files Browse the repository at this point in the history 
Earlier it was difficult to know the type of attribute just by looking
into documentation. This patch will help user to know type of attribute.
We are using terraform types. This fixes #621

terraform.io/docs/configuration/variables.html#type-constraints for
reference.

Signed-off-by: knrt10 <kautilya@kinvolk.io>
  • Loading branch information
@knrt10
knrt10 committed Jun 22, 2020
1 parent 373463f commit ab915a7
Show file tree
Hide file tree
Showing 21 changed files with 349 additions and 327 deletions.
9 changes: 5 additions & 4 deletions docs/configuration-reference/backend/local.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ backend "local" {

Default backend is local.

| Argument | Description | Default | Required |
|-----------------------------|--------------------------------------------------------------|:-------:|:--------:|
| `backend.local` | Local backend configuration block. | - | false |
| `backend.local.path` | Location where Lokomotive stores the cluster state. | - | false |
| Argument | Description | Default | Type | Required |
|----------------------|-----------------------------------------------------|:-------:|:------:|:--------:|
| `backend.local` | Local backend configuration block. | - | block | false |
| `backend.local.path` | Location where Lokomotive stores the cluster state. | - | string | false |


17 changes: 9 additions & 8 deletions docs/configuration-reference/backend/s3.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,15 @@ backend "s3" {

## Attribute reference

| Argument | Description | Default | Required |
|-----------------------------|--------------------------------------------------------------------------------------------------------------|:-------:|:--------:|
| `backend.s3` | AWS S3 backend configuration block. | - | false |
| `backend.s3.bucket` | Name of the S3 bucket where Lokomotive stores cluster state. | - | true |
| `backend.s3.key` | Path in the S3 bucket to store the cluster state. | - | true |
| `backend.s3.region` | AWS Region of the S3 bucket. | - | false |
| `backend.s3.aws_creds_path` | Path to the AWS credentials file. | - | false |
| `backend.s3.dynamodb_table` | Name of the DynamoDB table for locking the cluster state. The table must have a primary key named LockID. | - | false |
| Argument | Description | Default | Type | Required |
|-----------------------------|-----------------------------------------------------------------------------------------------------------|:-------:|:------:|:--------:|
| `backend.s3` | AWS S3 backend configuration block. | - | block | false |
| `backend.s3.bucket` | Name of the S3 bucket where Lokomotive stores cluster state. | - | string | true |
| `backend.s3.key` | Path in the S3 bucket to store the cluster state. | - | string | true |
| `backend.s3.region` | AWS Region of the S3 bucket. | - | string | false |
| `backend.s3.aws_creds_path` | Path to the AWS credentials file. | - | string | false |
| `backend.s3.dynamodb_table` | Name of the DynamoDB table for locking the cluster state. The table must have a primary key named LockID. | - | string | false |


>NOTE: In order for the installer to configure the credentials for S3 backend either pass them as
environment variables or in the config above.
Expand Down
9 changes: 5 additions & 4 deletions docs/configuration-reference/components/aws-ebs-csi-driver.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@ Table of all the arguments accepted by the component.

Example:

| Argument | Description | Default | Required |
|--------------------------------|------------------------------------------------------------------------------|:------------:|:--------:|
| `enable_default_storage_class` | Use the storage class provided by the component as the default storage class | true | false |
| Argument | Description | Default | Type | Required |
|--------------------------------|------------------------------------------------------------------------------|-------|-------|--------|
| `enable_default_storage_class` | Use the storage class provided by the component as the default storage class | true | bool | false |


## Applying

Expand All @@ -64,4 +65,4 @@ lokoctl component delete aws-ebs-csi-driver

**WARNING: Before destroying a cluster or deleting the component, EBS volumes
must be cleaned up manually.** Failing to do so would result in EBS volumes
being left behind.
being left behind.
12 changes: 7 additions & 5 deletions docs/configuration-reference/components/cert-manager.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,13 @@ Table of all the arguments accepted by the component.

Example:

| Argument | Description | Default | Required |
|-------------|--------------------------------------------------------------|:------------:|:--------:|
| `email` | Email used for certificates to receive expiry notifications. | - | true |
| `namespace` | Namespace to deploy the cert-manager into. | cert-manager | false |
| `webhooks` | Controls if webhooks should be deployed. | true | false |
| Argument | Description | Default | Type | Required |
|-------------------|----------------------------------------------------------------|:------------:|:------:|:--------:|
| `email` | Email used for certificates to receive expiry notifications. | - | string | true |
| `namespace` | Namespace to deploy the cert-manager into. | cert-manager | string | false |
| `webhooks` | Controls if webhooks should be deployed. | true | bool | false |
| `service_monitor` | Specifies how metrics can be retrieved from a set of services. | false | bool | false |


## Applying

Expand Down
32 changes: 17 additions & 15 deletions docs/configuration-reference/components/cluster-autoscaler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,21 +70,23 @@ Table of all the arguments accepted by the component.

Example:

| Argument | Description | Default | Required |
|------------------------------|------------------------------------------------------------------------------------------|:---------------|:--------:|
| `cluster_name` | Name of the cluster. | - | true |
| `worker_pool` | Name of the worker pool. | - | true |
| `namespace` | Namespace where the Cluster Autoscaler will be installed. | "kube-system" | false |
| `min_workers` | Minimum number of workers in the worker pool. | 1 | false |
| `max_workers` | Maximum number of workers in the worker pool. | 4 | false |
| `scale_down_unneeded_time` | How long a node should be unneeded before it is eligible for scale down. | "10m" | false |
| `scale_down_delay_after_add` | How long scale down should wait after a scale up. | "10m" | false |
| `scale_down_unready_time` | How long an unready node should be unneeded before it is eligible for scale down. | "20m" | false |
| `provider` | Supported provider, currently Packet. | "packet" | false |
| `packet.project_id` | Packet Project ID where the cluster is running. | - | true |
| `packet.facility` | Packet Facility where the cluster is running. | - | true |
| `packet.worker_type` | Machine type for workers spawned by the Cluster Autoscaler. | "t1.small.x86" | false |
| `packet_worker_channel` | Flatcar Container Linux channel to be used in workers spawned by the Cluster Autoscaler. | "stable" | false |
| Argument | Description | Default | Type | Required |
|------------------------------|------------------------------------------------------------------------------------------|:---------------|:------:|:--------:|
| `cluster_name` | Name of the cluster. | - | string | true |
| `worker_pool` | Name of the worker pool. | - | string | true |
| `namespace` | Namespace where the Cluster Autoscaler will be installed. | "kube-system" | string | false |
| `min_workers` | Minimum number of workers in the worker pool. | 1 | number | false |
| `max_workers` | Maximum number of workers in the worker pool. | 4 | number | false |
| `scale_down_unneeded_time` | How long a node should be unneeded before it is eligible for scale down. | "10m" | string | false |
| `scale_down_delay_after_add` | How long scale down should wait after a scale up. | "10m" | string | false |
| `scale_down_unready_time` | How long an unready node should be unneeded before it is eligible for scale down. | "20m" | string | false |
| `provider` | Supported provider, currently Packet. | "packet" | string | false |
| `service_monitor` | Specifies how metrics can be retrieved from a set of services. | false | bool | false |
| `packet.project_id` | Packet Project ID where the cluster is running. | - | string | true |
| `packet.facility` | Packet Facility where the cluster is running. | - | string | true |
| `packet.worker_type` | Machine type for workers spawned by the Cluster Autoscaler. | "t1.small.x86" | string | false |
| `packet_worker_channel` | Flatcar Container Linux channel to be used in workers spawned by the Cluster Autoscaler. | "stable" | string | false |


## Applying

Expand Down
15 changes: 8 additions & 7 deletions docs/configuration-reference/components/contour.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,14 @@ Table of all the arguments accepted by the component.

Example:

| Argument | Description | Default | Required |
|---------------------|---------------------------------------------------------------------------------------------------------|:--------------:|:--------:|
| `enable_monitoring` | Create Prometheus Operator configs to scrape Contour and Envoy metrics. Also deploys Grafana Dashboard. | false | false |
| `ingress_hosts` | [ExternalDNS component](external-dns.md) creates DNS entries from the values provided. | "" | false |
| `node_affinity` | Node affinity for deploying the operator pod and envoy daemonset. | - | false |
| `service_type` | The type of Kubernetes service used to expose Envoy. | "LoadBalancer" | false |
| `toleration` | Tolerations that the operator and envoy pods will tolerate. | - | false |
| Argument | Description | Default | Type | Required |
|---------------------|---------------------------------------------------------------------------------------------------------|:--------------:|:---------------------------------------------------------------------------------------------------------------|:--------:|
| `enable_monitoring` | Create Prometheus Operator configs to scrape Contour and Envoy metrics. Also deploys Grafana Dashboard. | false | bool | false |
| `ingress_hosts` | [ExternalDNS component](external-dns.md) creates DNS entries from the values provided. | "" | list(string) | false |
| `node_affinity` | Node affinity for deploying the operator pod and envoy daemonset. | - | list(object({key = string, operator = string, values = list(string)})) | false |
| `service_type` | The type of Kubernetes service used to expose Envoy. | "LoadBalancer" | string | false |
| `toleration` | Tolerations that the operator and envoy pods will tolerate. | - | list(object({key = string, effect = string, operator = string, value = string, toleration_seconds = string })) | false |


## Applying

Expand Down
Loading

0 comments on commit ab915a7

Please sign in to comment.