Skip to content

Commit

Permalink
Add documentation for OCI Registry feed
Browse files Browse the repository at this point in the history
  • Loading branch information
denys-octopus committed Oct 17, 2024
1 parent 2728956 commit a5f5609
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/data-sources/feeds.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ data "octopusdeploy_feeds" "example" {

### Optional

- `feed_type` (String) A filter to search by feed type. Valid feed types are `AwsElasticContainerRegistry`, `BuiltIn`, `Docker`, `GitHub`, `Helm`, `Maven`, `NuGet`, or `OctopusProject`.
- `feed_type` (String) A filter to search by feed type. Valid feed types are `AwsElasticContainerRegistry`, `BuiltIn`, `Docker`, `GitHub`, `Helm`, `Maven`, `NuGet`, `OciRegistry` or `OctopusProject`.
- `ids` (List of String) A filter to search by a list of IDs.
- `name` (String) The name of this resource.
- `partial_name` (String) A filter to search by a partial name.
Expand All @@ -49,7 +49,7 @@ Read-Only:
- `delete_unreleased_packages_after_days` (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) A filter to search by feed type. Valid feed types are `AwsElasticContainerRegistry`, `BuiltIn`, `Docker`, `GitHub`, `Helm`, `Maven`, `NuGet`, or `OctopusProject`.
- `feed_type` (String) A filter to search by feed type. Valid feed types are `AwsElasticContainerRegistry`, `BuiltIn`, `Docker`, `GitHub`, `Helm`, `Maven`, `NuGet`, `OciRegistry` or `OctopusProject`.
- `feed_uri` (String)
- `id` (String) The unique ID for this resource.
- `is_enhanced_mode` (Boolean)
Expand Down
48 changes: 48 additions & 0 deletions docs/resources/oci_registry_feed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "octopusdeploy_oci_registry_feed Resource - terraform-provider-octopusdeploy"
subcategory: ""
description: |-
This resource manages a OCI Registry feed in Octopus Deploy.
---

# octopusdeploy_oci_registry_feed (Resource)

This resource manages a OCI Registry feed in Octopus Deploy.

## Example Usage

```terraform
resource "octopusdeploy_oci_registry_feed" "example" {
feed_uri = "oci://test-registry.docker.io"
password = "test-password"
name = "Test oci Registry Feed (OK to Delete)"
username = "test-username"
}
```

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

### Required

- `feed_uri` (String)
- `name` (String) The name of this resource.

### Optional

- `password` (String, Sensitive) The password associated with this resource.
- `space_id` (String) The space ID associated with this OCI registry.
- `username` (String, Sensitive) The username associated with this resource.

### Read-Only

- `id` (String) The unique ID for this resource.

## Import

Import is supported using the following syntax:

```shell
terraform import [options] octopusdeploy_oci_registry_feed.<name> <feed-id>
```
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
terraform import [options] octopusdeploy_oci_registry_feed.<name> <feed-id>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
resource "octopusdeploy_oci_registry_feed" "example" {
feed_uri = "oci://test-registry.docker.io"
password = "test-password"
name = "Test oci Registry Feed (OK to Delete)"
username = "test-username"
}

0 comments on commit a5f5609

Please sign in to comment.