Skip to content

Commit

Permalink
Merge pull request #196 from jfrog/GH-129-add-bin-manager-support
Browse files Browse the repository at this point in the history
Add missing usage and import examples for new resources
  • Loading branch information
alexhung committed May 29, 2024
2 parents 438905a + 0e5d339 commit ec5999f
Show file tree
Hide file tree
Showing 7 changed files with 77 additions and 1 deletion.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 2.7.1 (May 29, 2024). Tested on Artifactory 7.84.12 and Xray 3.96.1

IMPROVEMENTS:

* resource/xray_binary_manager_repos and resource/xray_binary_manager_builds: Add missing usage and import examples to documentation. PR: [#196](https://github.com/jfrog/terraform-provider-xray/pull/196) Issue: [#129](https://github.com/jfrog/terraform-provider-xray/issues/129)

## 2.7.0 (May 29, 2024). Tested on Artifactory 7.84.12 and Xray 3.96.1

FEATURES:
Expand Down
17 changes: 17 additions & 0 deletions docs/resources/binary_manager_builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,14 @@ description: |-

Provides an Xray Binary Manager Builds Indexing configuration resource. See [Indexing Xray Resources](https://jfrog.com/help/r/jfrog-security-documentation/add-or-remove-resources-from-indexing) and [REST API](https://jfrog.com/help/r/xray-rest-apis/update-builds-indexing-configuration) for more details.

## Example Usage

```terraform
resource "xray_binary_manager_builds" "my-indexed-builds" {
id = "default"
indexed_builds = ["my-build-1", "my-build-2"]
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand All @@ -27,3 +34,13 @@ Provides an Xray Binary Manager Builds Indexing configuration resource. See [Ind
### Read-Only

- `non_indexed_builds` (Set of String) Non-indexed builds for output.

## Import

Import is supported using the following syntax:

```shell
terraform import xray_binary_manager_builds.my-indexed-builds default

terraform import xray_binary_manager_builds.my-indexed-builds default:my-project-key
```
30 changes: 29 additions & 1 deletion docs/resources/binary_manager_repos.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,25 @@ description: |-

Provides an Xray Binary Manager Repository Indexing configuration resource. See [Indexing Xray Resources](https://jfrog.com/help/r/jfrog-security-documentation/add-or-remove-resources-from-indexing) and [REST API](https://jfrog.com/help/r/xray-rest-apis/update-repos-indexing-configuration) for more details.


## Example Usage

```terraform
resource "xray_binary_manager_repos" "my-indexed-repos" {
id = "default"
indexed_repos = [
{
name = "my-generic-local"
type = "local"
package_type = "Generic"
},
{
name = "my-npm-remote"
type = "remote"
package_type = "Npm"
}
]
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down Expand Up @@ -46,3 +64,13 @@ Required:
- `name` (String)
- `package_type` (String)
- `type` (String)

## Import

Import is supported using the following syntax:

```shell
terraform import xray_binary_manager_repos.my-indexed-repos default

terraform import xray_binary_manager_repos.my-indexed-repos default:my-project-key
```
3 changes: 3 additions & 0 deletions examples/resources/xray_binary_manager_builds/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
terraform import xray_binary_manager_builds.my-indexed-builds default

terraform import xray_binary_manager_builds.my-indexed-builds default:my-project-key
4 changes: 4 additions & 0 deletions examples/resources/xray_binary_manager_builds/resource.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
resource "xray_binary_manager_builds" "my-indexed-builds" {
id = "default"
indexed_builds = ["my-build-1", "my-build-2"]
}
3 changes: 3 additions & 0 deletions examples/resources/xray_binary_manager_repos/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
terraform import xray_binary_manager_repos.my-indexed-repos default

terraform import xray_binary_manager_repos.my-indexed-repos default:my-project-key
15 changes: 15 additions & 0 deletions examples/resources/xray_binary_manager_repos/resource.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
resource "xray_binary_manager_repos" "my-indexed-repos" {
id = "default"
indexed_repos = [
{
name = "my-generic-local"
type = "local"
package_type = "Generic"
},
{
name = "my-npm-remote"
type = "remote"
package_type = "Npm"
}
]
}

0 comments on commit ec5999f

Please sign in to comment.