Merge pull request #146 from OctopusDeployLabs/feat-feed-specific-res…

…ources feat: support feed types
OctopusDeployLabs · Mar 29, 2021 · db11f63 · db11f63
2 parents 317af5d + b8573e7
commit db11f63
Show file tree

Hide file tree

Showing 46 changed files with 1,942 additions and 86 deletions.
diff --git a/docs/data-sources/feeds.md b/docs/data-sources/feeds.md
@@ -6,7 +6,7 @@ description: |-
   Provides information about existing feeds.
 ---
 
-# Data Source `octopusdeploy_feeds`
+# octopusdeploy_feeds (Data Source)
 
 Provides information about existing feeds.
 
@@ -24,25 +24,25 @@ Provides information about existing feeds.
 - **skip** (Number) A filter to specify the number of items to skip in the response.
 - **take** (Number) A filter to specify the number of items to take (or return) in the response.
 
-### Read-only
+### Read-Only
 
 - **feeds** (Block List) A list of feeds that match the filter(s). (see [below for nested schema](#nestedblock--feeds))
 
 <a id="nestedblock--feeds"></a>
 ### Nested Schema for `feeds`
 
-Read-only:
+Read-Only:
 
 - **access_key** (String)
 - **api_version** (String)
 - **delete_unreleased_packages_after_days** (Number)
-- **download_attempts** (Number)
-- **download_retry_backoff_seconds** (Number)
+- **download_attempts** (Number) The number of times a deployment should attempt to download a package from this feed before failing.
+- **download_retry_backoff_seconds** (Number) The number of seconds to apply as a linear back off between download attempts.
 - **feed_type** (String)
 - **feed_uri** (String)
 - **id** (String) The unique ID for this resource.
 - **is_enhanced_mode** (Boolean)
-- **name** (String) The name of this resource.
+- **name** (String) A short, memorable, unique name for this feed. Example: ACME Builds.
 - **package_acquisition_location_options** (List of String)
 - **password** (String, Sensitive) The password associated with this resource.
 - **region** (String)

diff --git a/docs/resources/aws_elastic_container_registry.md b/docs/resources/aws_elastic_container_registry.md
@@ -0,0 +1,45 @@
+---
+page_title: "Resource octopusdeploy_aws_elastic_container_registry - terraform-provider-octopusdeploy"
+subcategory: "Feeds"
+description: |-
+  This resource manages a AWS Elastic Container Registry in Octopus Deploy.
+---
+
+# Resource (octopusdeploy_aws_elastic_container_registry)
+
+This resource manages a AWS Elastic Container Registry in Octopus Deploy.
+
+## Example Usage
+
+```terraform
+resource "octopusdeploy_aws_elastic_container_registry" "example" {
+  access_key = "AKIAIOSFODNN7EXAMPLE"
+  name       = "Test AWS Elastic Container Registry (OK to Delete)"
+  region     = "us-east-1"
+  secret_key = "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **access_key** (String) The AWS access key to use when authenticating against Amazon Web Services.
+- **name** (String) A short, memorable, unique name for this feed. Example: ACME Builds.
+- **region** (String) The AWS region where the registry resides.
+- **secret_key** (String, Sensitive) The AWS secret key to use when authenticating against Amazon Web Services.
+
+### Optional
+
+- **id** (String) The unique ID for this feed.
+- **package_acquisition_location_options** (List of String)
+- **space_id** (String) The space ID associated with this feed.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import [options] octopusdeploy_aws_elastic_container_registry.<name> <feed-id>
+```
diff --git a/docs/resources/docker_container_registry.md b/docs/resources/docker_container_registry.md
@@ -0,0 +1,48 @@
+---
+page_title: "Resource octopusdeploy_docker_container_registry - terraform-provider-octopusdeploy"
+subcategory: "Feeds"
+description: |-
+  This resource manages a Docker Container Registry in Octopus Deploy.
+---
+
+# Resource (octopusdeploy_docker_container_registry)
+
+This resource manages a Docker Container Registry in Octopus Deploy.
+
+## Example Usage
+
+```terraform
+resource "octopusdeploy_docker_container_registry" "example" {
+  feed_uri      = "https://index.docker.io"
+  name          = "Test Docker Container Registry (OK to Delete)"
+  password      = "test-password"
+  registry_path = "testing/test-image"
+  username      = "test-username"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **feed_uri** (String) The URL to a Maven repository. This URL is the same value defined in the `repositories`/`repository`/`url` element of a Maven `settings.xml` file.
+- **name** (String) A short, memorable, unique name for this feed. Example: ACME Builds.
+
+### Optional
+
+- **api_version** (String)
+- **id** (String) The unique ID for this resource.
+- **package_acquisition_location_options** (List of String)
+- **password** (String, Sensitive) The password associated with this resource.
+- **registry_path** (String)
+- **space_id** (String) The space ID associated with this resource.
+- **username** (String, Sensitive) The username associated with this resource.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import [options] octopusdeploy_docker_container_registry.<name> <feed-id>
+```
diff --git a/docs/resources/feed.md b/docs/resources/feed.md
@@ -1,32 +1,44 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "octopusdeploy_feed Resource - terraform-provider-octopusdeploy"
-subcategory: ""
+page_title: "Resource octopusdeploy_feed - terraform-provider-octopusdeploy"
+subcategory: "Feeds"
 description: |-
   
 ---
 
-# Resource `octopusdeploy_feed`
+# Resource (octopusdeploy_feed)
 
 
 
+## Example Usage
 
+```terraform
+resource "octopusdeploy_feed" "example" {
+  download_attempts                    = 10
+  download_retry_backoff_seconds       = 60
+  feed_uri                             = "https://repo.maven.apache.org/maven2/"
+  name                                 = "Test Maven Feed (OK to Delete)"
+  package_acquisition_location_options = ["Server", "ExecutionTarget"]
+  password                             = "password123"
+  space_id                             = "Spaces-123"
+  username                             = "john.smith@example.com"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
 - **feed_uri** (String)
-- **name** (String) The name of this resource.
+- **name** (String) A short, memorable, unique name for this feed. Example: ACME Builds.
 
 ### Optional
 
 - **access_key** (String)
 - **api_version** (String)
 - **delete_unreleased_packages_after_days** (Number)
-- **download_attempts** (Number)
-- **download_retry_backoff_seconds** (Number)
+- **download_attempts** (Number) The number of times a deployment should attempt to download a package from this feed before failing.
+- **download_retry_backoff_seconds** (Number) The number of seconds to apply as a linear back off between download attempts.
 - **feed_type** (String)
 - **id** (String) The unique ID for this resource.
 - **is_enhanced_mode** (Boolean)
@@ -37,8 +49,14 @@ description: |-
 - **space_id** (String) The space ID associated with this resource.
 - **username** (String, Sensitive) The username associated with this resource.
 
-### Read-only
+### Read-Only
 
 - **region** (String)
 
+## Import
 
+Import is supported using the following syntax:
+
+```shell
+terraform import [options] octopusdeploy_feed.<name> <feed-id>
+```
diff --git a/docs/resources/github_repository_feed.md b/docs/resources/github_repository_feed.md
@@ -0,0 +1,49 @@
+---
+page_title: "Resource octopusdeploy_github_repository_feed - terraform-provider-octopusdeploy"
+subcategory: "Feeds"
+description: |-
+  This resource manages a GitHub repository feed in Octopus Deploy.
+---
+
+# Resource (octopusdeploy_github_repository_feed)
+
+This resource manages a GitHub repository feed in Octopus Deploy.
+
+## Example Usage
+
+```terraform
+resource "octopusdeploy_github_repository_feed" "example" {
+  download_attempts              = 1
+  download_retry_backoff_seconds = 30
+  feed_uri                       = "https://api.github.com"
+  password                       = "test-password"
+  name                           = "Test GitHub Repository Feed (OK to Delete)"
+  username                       = "test-username"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **feed_uri** (String)
+- **name** (String) A short, memorable, unique name for this feed. Example: ACME Builds.
+
+### Optional
+
+- **download_attempts** (Number) The number of times a deployment should attempt to download a package from this feed before failing.
+- **download_retry_backoff_seconds** (Number) The number of seconds to apply as a linear back off between download attempts.
+- **id** (String) The unique ID for this resource.
+- **package_acquisition_location_options** (List of String)
+- **password** (String, Sensitive) The password associated with this resource.
+- **space_id** (String) The space ID associated with this resource.
+- **username** (String, Sensitive) The username associated with this resource.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import [options] octopusdeploy_github_repository_feed.<name> <feed-id>
+```
diff --git a/docs/resources/helm_feed.md b/docs/resources/helm_feed.md
@@ -0,0 +1,45 @@
+---
+page_title: "Resource octopusdeploy_helm_feed - terraform-provider-octopusdeploy"
+subcategory: "Feeds"
+description: |-
+  This resource manages a Helm feed in Octopus Deploy.
+---
+
+# Resource (octopusdeploy_helm_feed)
+
+This resource manages a Helm feed in Octopus Deploy.
+
+## Example Usage
+
+```terraform
+resource "octopusdeploy_helm_feed" "example" {
+  feed_uri = "https://charts.helm.sh/stable"
+  password = "test-password"
+  name     = "Test Helm Feed (OK to Delete)"
+  username = "test-username"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **feed_uri** (String)
+- **name** (String) A short, memorable, unique name for this feed. Example: ACME Builds.
+
+### Optional
+
+- **id** (String) The unique ID for this resource.
+- **package_acquisition_location_options** (List of String)
+- **password** (String, Sensitive) The password associated with this resource.
+- **space_id** (String) The space ID associated with this resource.
+- **username** (String, Sensitive) The username associated with this resource.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import [options] octopusdeploy_helm_feed.<name> <feed-id>
+```
diff --git a/docs/resources/maven_feed.md b/docs/resources/maven_feed.md
@@ -0,0 +1,51 @@
+---
+page_title: "Resource octopusdeploy_maven_feed - terraform-provider-octopusdeploy"
+subcategory: "Feeds"
+description: |-
+  This resource manages a Maven feed in Octopus Deploy.
+---
+
+# Resource (octopusdeploy_maven_feed)
+
+This resource manages a Maven feed in Octopus Deploy.
+
+## Example Usage
+
+```terraform
+resource "octopusdeploy_maven_feed" "example" {
+  download_attempts                    = 10
+  download_retry_backoff_seconds       = 60
+  feed_uri                             = "https://repo.maven.apache.org/maven2/"
+  name                                 = "Test Maven Feed (OK to Delete)"
+  package_acquisition_location_options = ["Server", "ExecutionTarget"]
+  password                             = "password123"
+  space_id                             = "Spaces-123"
+  username                             = "john.smith@example.com"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **feed_uri** (String)
+- **name** (String) A short, memorable, unique name for this feed. Example: ACME Builds.
+
+### Optional
+
+- **download_attempts** (Number) The number of times a deployment should attempt to download a package from this feed before failing.
+- **download_retry_backoff_seconds** (Number) The number of seconds to apply as a linear back off between download attempts.
+- **id** (String) The unique ID for this resource.
+- **package_acquisition_location_options** (List of String)
+- **password** (String, Sensitive) The password associated with this resource.
+- **space_id** (String) The space ID associated with this resource.
+- **username** (String, Sensitive) The username associated with this resource.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import [options] octopusdeploy_maven_feed.<name> <feed-id>
+```