Skip to content

Commit

Permalink
Added documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wrighbr committed Oct 19, 2020
1 parent 8da2f16 commit 5c0ce18
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/data-sources/project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Data Source: harbor_project

## Example Usage
```hcl
data "haror_project" "main" {
name = "library"
}
output "project_id" {
value = data.harbor_project.main.id
}
```

## Argument Reference
The following arguments are supported:

* **name** - (Required) The of the project that will be created in harbor.

## Attributes Reference
In addition to all argument, the folloing attributes are exported:

* **project_id** - The id of the project within harbor.

* **public** - If the project will be public accessibility.

* **vulnerability_scanning** - If the images will be scanned for vulnerabilities when push to harbor.
33 changes: 33 additions & 0 deletions docs/data-sources/registry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Data Source: harbor_registry

## Example Usage

```hcl
data "harbor_registry" "main" {
name = "test_docker_harbor"
}
output "harbor_registry_id" {
value = data.harbor_registry.main.id
}
```

## Argument Reference
The following arguments are supported:

* **name** - (Required) The name of the register.

## Attributes Reference
In addition to all argument, the folloing attributes are exported:

* **registry_id** - The id of the register within harbor.

* **status** - The health status of the external container register

* **endpoint_url** - The url endpoint for the external container register

* **description** - The description of the external container register.

* **insecure** - If the certificate of the external container register can be verified.

* **type** - The type of the provider type.

0 comments on commit 5c0ce18

Please sign in to comment.