Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
micahlmartin committed Sep 2, 2021
1 parent 6dce255 commit 1ed3360
Show file tree
Hide file tree
Showing 34 changed files with 264 additions and 33 deletions.
2 changes: 1 addition & 1 deletion docs/data-sources/application.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_application Data Source - harness"
page_title: "harness_application Data Source - terraform-provider-harness"
subcategory: ""
description: |-
Data source for retrieving a Harness application
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/encrypted_text.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_encrypted_text Data Source - harness"
page_title: "harness_encrypted_text Data Source - terraform-provider-harness"
subcategory: ""
description: |-
Data source for retrieving a Harness application
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/environment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_environment Data Source - harness"
page_title: "harness_environment Data Source - terraform-provider-harness"
subcategory: ""
description: |-
Data source for retrieving a Harness service
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/git_connector.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_git_connector Data Source - harness"
page_title: "harness_git_connector Data Source - terraform-provider-harness"
subcategory: ""
description: |-
Data source for retrieving a Harness application
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/secret_manager.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_secret_manager Data Source - harness"
page_title: "harness_secret_manager Data Source - terraform-provider-harness"
subcategory: ""
description: |-
Data source for retrieving a Harness secret manager
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/service.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_service Data Source - harness"
page_title: "harness_service Data Source - terraform-provider-harness"
subcategory: ""
description: |-
Data source for retrieving a Harness service
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/sso_provider.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_sso_provider Data Source - harness"
page_title: "harness_sso_provider Data Source - terraform-provider-harness"
subcategory: ""
description: |-
Data source for retrieving an SSO providers
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/user.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_user Data Source - harness"
page_title: "harness_user Data Source - terraform-provider-harness"
subcategory: ""
description: |-
Data source for retrieving a Harness user
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/user_group.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_user_group Data Source - harness"
page_title: "harness_user_group Data Source - terraform-provider-harness"
subcategory: ""
description: |-
Data source for retrieving a Harness user group
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/add_user_to_group.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_add_user_to_group Resource - harness"
page_title: "harness_add_user_to_group Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for adding a user to a group.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/application.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_application Resource - harness"
page_title: "harness_application Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for creating a Harness application
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cloudprovider_aws.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_cloudprovider_aws Resource - harness"
page_title: "harness_cloudprovider_aws Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for creating a physical data center cloud provider
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cloudprovider_azure.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_cloudprovider_azure Resource - harness"
page_title: "harness_cloudprovider_azure Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for creating an Azure cloud provider
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cloudprovider_datacenter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_cloudprovider_datacenter Resource - harness"
page_title: "harness_cloudprovider_datacenter Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for creating a physical data center cloud provider
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cloudprovider_gcp.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_cloudprovider_gcp Resource - harness"
page_title: "harness_cloudprovider_gcp Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for creating a GCP cloud provider
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cloudprovider_kubernetes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_cloudprovider_kubernetes Resource - harness"
page_title: "harness_cloudprovider_kubernetes Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for creating a GCP cloud provider
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cloudprovider_spot.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_cloudprovider_spot Resource - harness"
page_title: "harness_cloudprovider_spot Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for creating a GCP cloud provider
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cloudprovider_tanzu.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_cloudprovider_tanzu Resource - harness"
page_title: "harness_cloudprovider_tanzu Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for creating a Tanzu cloud provider
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/encrypted_text.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_encrypted_text Resource - harness"
page_title: "harness_encrypted_text Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for creating an encrypted text secret
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/environment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_environment Resource - harness"
page_title: "harness_environment Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for creating an environment
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/git_connector.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_git_connector Resource - harness"
page_title: "harness_git_connector Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for creating a git connector
Expand Down
231 changes: 231 additions & 0 deletions docs/resources/infrastructure_definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,231 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "harness_infrastructure_definition Resource - terraform-provider-harness"
subcategory: ""
description: |-
Resource for creating am infrastructure definition
---

# harness_infrastructure_definition (Resource)

Resource for creating am infrastructure definition



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **app_id** (String) The id of the application the infrastructure definition belongs to.
- **cloud_provider_type** (String) The type of the cloud provider to connect with. Valid options are AWS, AZURE, CUSTOM, PHYSICAL_DATA_CENTER, KUBERNETES_CLUSTER, PCF, SPOT_INST
- **deployment_type** (String) The type of the deployment to use. Valid options are AMI, AWS_CODEDEPLOY, AWS_LAMBDA, AZURE_VMSS, AZURE_WEBAPP, Custom, ECS, HELM, KUBERNETES, PCF, SSH, WINRM
- **env_id** (String) The id of the environment the infrastructure definition belongs to.
- **name** (String) The name of the infrastructure definition

### Optional

- **aws_ami** (Block List, Max: 1) The configuration details for Aws AMI deployments. (see [below for nested schema](#nestedblock--aws_ami))
- **aws_ecs** (Block List, Max: 1) The configuration details for Aws AMI deployments. (see [below for nested schema](#nestedblock--aws_ecs))
- **aws_lambda** (Block List, Max: 1) The configuration details for Aws Lambda deployments. (see [below for nested schema](#nestedblock--aws_lambda))
- **aws_ssh** (Block List, Max: 1) The configuration details for AWS SSH deployments. (see [below for nested schema](#nestedblock--aws_ssh))
- **aws_winrm** (Block List, Max: 1) The configuration details for AWS WinRM deployments. (see [below for nested schema](#nestedblock--aws_winrm))
- **azure_vmss** (Block List, Max: 1) The configuration details for Azure VMSS deployments. (see [below for nested schema](#nestedblock--azure_vmss))
- **azure_webapp** (Block List, Max: 1) The configuration details for Azure WebApp deployments. (see [below for nested schema](#nestedblock--azure_webapp))
- **datacenter_ssh** (Block List, Max: 1) The configuration details for SSH datacenter deployments. (see [below for nested schema](#nestedblock--datacenter_ssh))
- **datacenter_winrm** (Block List, Max: 1) The configuration details for WinRM datacenter deployments. (see [below for nested schema](#nestedblock--datacenter_winrm))
- **deployment_template_uri** (String) The URI of the deployment template to use. Only used if deployment_type is `CUSTOM`.
- **kubernetes** (Block List, Max: 1) The configuration details for Kubernetes deployments. (see [below for nested schema](#nestedblock--kubernetes))
- **kubernetes_gcp** (Block List, Max: 1) The configuration details for Kubernetes on GCP deployments. (see [below for nested schema](#nestedblock--kubernetes_gcp))
- **provisioner_name** (String) The name of the infrastructure provisioner to use.
- **scoped_services** (Set of String) The list of service names to scope this infrastructure definition to.
- **tanzu** (Block List, Max: 1) The configuration details for PCF deployments. (see [below for nested schema](#nestedblock--tanzu))

### Read-Only

- **id** (String) The unique id of the infrastructure definition.

<a id="nestedblock--aws_ami"></a>
### Nested Schema for `aws_ami`

Required:

- **ami_deployment_type** (String) The ami deployment type to use. Valid options are AWS_ASG, SPOTINST
- **cloud_provider_name** (String) The name of the cloud provider to connect with.
- **region** (String) The region to deploy to.

Optional:

- **asg_identifies_workload** (Boolean) Flag to indicate whether the autoscaling group identifies the workload.
- **autoscaling_group_name** (String) The name of the autoscaling group.
- **classic_loadbalancers** (Set of String) The classic load balancers to use.
- **hostname_convention** (String) The naming convention to use for the hostname. Defaults to ${host.ec2Instance.privateDnsName.split('\.')[0]}
- **spotinst_cloud_provider_name** (String) The name of the SpotInst cloud provider to connect with.
- **spotinst_config_json** (String) The SpotInst configuration to use.
- **stage_classic_loadbalancers** (Set of String) The staging classic load balancers to use.
- **stage_target_group_arns** (Set of String) The staging classic load balancers to use.
- **target_group_arns** (Set of String) The ARN's of the target groups.
- **use_traffic_shift** (Boolean) Flag to enable traffic shifting.


<a id="nestedblock--aws_ecs"></a>
### Nested Schema for `aws_ecs`

Required:

- **cloud_provider_name** (String) The name of the cloud provider to connect with.
- **cluster_name** (String) The name of the ECS cluster to use.
- **launch_type** (String) The type of launch configuration to use. Valid options are FARGATE
- **region** (String) The region to deploy to.

Optional:

- **assign_public_ip** (Boolean) Flag to assign a public IP address.
- **execution_role** (String) The ARN of the role to use for execution.
- **security_group_ids** (Set of String) The security group ids to apply to the ecs service.
- **subnet_ids** (Set of String) The subnet ids to apply to the ecs service.
- **vpc_id** (String) The VPC ids to use when selecting the instances.


<a id="nestedblock--aws_lambda"></a>
### Nested Schema for `aws_lambda`

Required:

- **cloud_provider_name** (String) The name of the cloud provider to connect with.
- **iam_role** (String) The IAM role to use.
- **region** (String) The region to deploy to.

Optional:

- **security_group_ids** (Set of String) The security group ids to apply to the ecs service.
- **subnet_ids** (Set of String) The subnet ids to apply to the ecs service.
- **vpc_id** (String) The VPC ids to use when selecting the instances.


<a id="nestedblock--aws_ssh"></a>
### Nested Schema for `aws_ssh`

Required:

- **cloud_provider_name** (String) The name of the cloud provider to connect with.
- **host_connection_type** (String) The type of host connection to use. Valid options are PRIVATE_DNS, PUBLIC_DNS, PRIVATE_IP, PUBLIC_IP
- **region** (String) The region to deploy to.

Optional:

- **autoscaling_group_name** (String) The name of the autoscaling group.
- **desired_capacity** (Number) The desired capacity of the auto scaling group.
- **host_connection_attrs_name** (String) The name of the host connection attributes to use.
- **hostname_convention** (String) The naming convention to use for the hostname. Defaults to ${host.ec2Instance.privateDnsName.split('\.')[0]}
- **loadbalancer_name** (String) The name of the load balancer to use.
- **tag** (Block Set) The tags to use when selecting the instances. (see [below for nested schema](#nestedblock--aws_ssh--tag))
- **vpc_ids** (Set of String) The VPC ids to use when selecting the instances.

<a id="nestedblock--aws_ssh--tag"></a>
### Nested Schema for `aws_ssh.tag`

Required:

- **key** (String) The key of the tag.
- **value** (String) The value of the tag.



<a id="nestedblock--aws_winrm"></a>
### Nested Schema for `aws_winrm`

Required:

- **autoscaling_group_name** (String) The name of the autoscaling group.
- **cloud_provider_name** (String) The name of the cloud provider to connect with.
- **host_connection_attrs_name** (String) The name of the host connection attributes to use.
- **host_connection_type** (String) The type of host connection to use. Valid options are PRIVATE_DNS, PUBLIC_DNS, PRIVATE_IP, PUBLIC_IP
- **region** (String) The region to deploy to.

Optional:

- **desired_capacity** (Number) The desired capacity of the autoscaling group.
- **hostname_convention** (String) The naming convention to use for the hostname. Defaults to ${host.ec2Instance.privateDnsName.split('\.')[0]}
- **loadbalancer_name** (String) The name of the load balancer to use.


<a id="nestedblock--azure_vmss"></a>
### Nested Schema for `azure_vmss`

Required:

- **auth_type** (String) The type of authentication to use. Valid options are SSH_PUBLIC_KEY.
- **base_name** (String) Base name.
- **cloud_provider_name** (String) The name of the cloud provider to connect with.
- **deployment_type** (String) The type of deployment. Valid options are NATIVE_VMSS
- **resource_group_name** (String) The name of the resource group.
- **subscription_id** (String) The unique id of the azure subscription.
- **username** (String) The username to connect with.

Optional:

- **host_connection_attrs_name** (String) The name of the host connection attributes to use.


<a id="nestedblock--azure_webapp"></a>
### Nested Schema for `azure_webapp`

Required:

- **cloud_provider_name** (String) The name of the cloud provider to connect with.
- **resource_group** (String) The name of the resource group.
- **subscription_id** (String) The unique id of the azure subscription.


<a id="nestedblock--datacenter_ssh"></a>
### Nested Schema for `datacenter_ssh`

Required:

- **cloud_provider_name** (String) The name of the cloud provider to connect with.
- **host_connection_attributes_name** (String) The name of the SSH connection attributes to use.
- **hostnames** (Set of String) A list of hosts to deploy to.


<a id="nestedblock--datacenter_winrm"></a>
### Nested Schema for `datacenter_winrm`

Required:

- **cloud_provider_name** (String) The name of the cloud provider to connect with.
- **hostnames** (Set of String) A list of hosts to deploy to.
- **winrm_connection_attributes_name** (String) The name of the WinRM connection attributes to use.


<a id="nestedblock--kubernetes"></a>
### Nested Schema for `kubernetes`

Required:

- **cloud_provider_name** (String) The name of the cloud provider to connect with.
- **namespace** (String) The namespace in Kubernetes to deploy to.
- **release_name** (String) The naming convention of the release. When using Helm Native the default is ${infra.kubernetes.infraId}. For standard Kubernetes manifests the default is release-${infra.kubernetes.infraId}


<a id="nestedblock--kubernetes_gcp"></a>
### Nested Schema for `kubernetes_gcp`

Required:

- **cloud_provider_name** (String) The name of the cloud provider to connect with.
- **cluster_name** (String) The name of the cluster being deployed to.
- **namespace** (String) The namespace in Kubernetes to deploy to.
- **release_name** (String) The naming convention of the release.


<a id="nestedblock--tanzu"></a>
### Nested Schema for `tanzu`

Required:

- **cloud_provider_name** (String) The name of the cloud provider to connect with.
- **organization** (String) The PCF organization to use.
- **space** (String) The PCF space to deploy to.


Loading

0 comments on commit 1ed3360

Please sign in to comment.