-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This PR is to bring the docs into line with the recommended style from hashicorp, using their tool [tfplugindocs](https://github.com/hashicorp/terraform-plugin-docs) I tried to keep the docs feeling mostly the same well being within "spec", please let me know if any of the new docs are out of date. I mostly tried to keep what was still valid arguments and the descriptions for those arguments. --------- Signed-off-by: Allen Conlon <allen@conlon.dev>
- Loading branch information
Showing
86 changed files
with
3,736 additions
and
570 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # source https://github.com/hashicorp/terraform-provider-awscc/blob/main/.github/workflows/tfplugindocs-check.yml | ||
|
|
||
| name: Check if tfplugindocs result matches /docs | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - "release/**" | ||
| pull_request: | ||
| paths: | ||
| - .github/workflows/tfplugindocs-check.yml | ||
| - go.sum | ||
| - Makefile | ||
| - client/** | ||
| - main.go | ||
| - docs/** | ||
|
|
||
| jobs: | ||
| tfplugindocs_check: | ||
| name: tfplugindocs check | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4.1.1 | ||
| - uses: actions/setup-go@v5.0.0 | ||
| with: | ||
| go-version-file: tools/go.mod | ||
| - name: GOCACHE | ||
| run: | | ||
| echo "GOCACHE=$(go env GOCACHE)" >> $GITHUB_ENV | ||
| - uses: actions/cache@v4.0.0 | ||
| continue-on-error: true | ||
| timeout-minutes: 2 | ||
| with: | ||
| # TODO: Replace with supported mechanism when it is supported | ||
| # https://github.com/actions/setup-go/issues/54 | ||
| path: ${{ env.GOCACHE }} | ||
| key: ${{ runner.os }}-GOCACHE-${{ hashFiles('go.sum') }}-${{ hashFiles('internal/**') }} | ||
| - uses: actions/cache@v4.0.0 | ||
| continue-on-error: true | ||
| timeout-minutes: 2 | ||
| with: | ||
| path: ~/go/pkg/mod | ||
| key: ${{ runner.os }}-go-pkg-mod-${{ hashFiles('go.sum') }} | ||
| - run: | | ||
| make tools | ||
| make docs | ||
| git add -N docs/ | ||
| git diff --exit-code |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| ACCTEST_PARALLELISM ?= 20 | ||
| GO_VER ?= go | ||
|
|
||
| default: tools | ||
|
|
||
| .PHONY: tools docs default | ||
|
|
||
| all: tools docs | ||
|
|
||
| tools: | ||
| cd tools && $(GO_VER) install github.com/golangci/golangci-lint/cmd/golangci-lint | ||
| cd tools && $(GO_VER) install github.com/pavius/impi/cmd/impi | ||
| cd tools && $(GO_VER) install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs | ||
|
|
||
| docs: | ||
| rm -f docs/data-sources/*.md | ||
| rm -f docs/resources/*.md | ||
| @tfplugindocs generate |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,25 @@ | ||
| # Harbor Provider | ||
| The Harbor provider is used to configure an instance of Harbor. The provider needs to be configured with the proper credentials before it can be used. | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "harbor Provider" | ||
| subcategory: "" | ||
| description: |- | ||
| --- | ||
|
|
||
| ## Resources | ||
| * [Resource: harbor_configuration](resources/configuration.md) | ||
| * [Resource: harbor_config_system](resources/config_system.md) | ||
| * [Resource: harbor_config_email](resources/config_email.md) | ||
| * [Resource: harbor_garbage_collection](resources/garbage_collection.md) | ||
| * [Resource: harbor_purge_audit_log](resources/purge-audit-log.md) | ||
| * [Resource: harbor_immutable_tag_rule](resources/immutable_tag_rule.md) | ||
| * [Resource: harbor_interrogation_services](resources/interrogation_services.md) | ||
| * [Resource: harbor_label](resources/label.md) | ||
| * [Resource: harbor_project_member_group](resources/project_member_group.md) | ||
| * [Resource: harbor_project_member_user](resources/project_member_user.md) | ||
| * [Resource: harbor_project](resources/project.md) | ||
| * [Resource: harbor_registry](resources/registry.md) | ||
| * [Resource: harbor_replication](resources/replication.md) | ||
| * [Resource: harbor_retention_policy](resources/retention_policy.md) | ||
| * [Resource: harbor_robot_account](resources/robot_account.md) | ||
| * [Resource: harbor_tasks](resources/tasks.md) | ||
| * [Resource: harbor_user](resources/user.md) | ||
| # harbor Provider | ||
|
|
||
| ## Authentication | ||
| ```hcl | ||
| provider "harbor" { | ||
| url = "https://harbor.aceme_corpartion.com" | ||
| username = "insert_admin_username_here" | ||
| password = "insert_password_here" | ||
| bearer_token = "insert_bearer_token_here" | ||
| } | ||
| ``` | ||
| <!-- schema generated by tfplugindocs --> | ||
|
|
||
| Alternatively, these environment variables can be used to set the provider config values: | ||
| ``` | ||
| HARBOR_URL | ||
| HARBOR_USERNAME | ||
| HARBOR_PASSWORD | ||
| HARBOR_BEARER_TOKEN | ||
| HARBOR_IGNORE_CERT | ||
| ``` | ||
| ## Schema | ||
|
|
||
| ## Argument Reference | ||
| The following arguments are supported: | ||
| ### Required | ||
|
|
||
| * **url** - (Required) The url of harbor | ||
| * **username** - (Required) The username to be used to access harbor | ||
| * **password** - (Required) The password to be used to access harbor | ||
| * **bearer_token** - (Optional) The bearer token to be used to access harbor. Will take precedence over username and password if set | ||
| * **insecure** - (Optional) Choose to ignore certificate errors | ||
| * **api_version** - (Optional) Choose which version of the api you would like to use 1 or 2. Default is `2` | ||
| - `url` (String) The url of harbor | ||
| - `password` (String) The password to be used to access harbor | ||
| - `username` (String) The username to be used to access harbor | ||
|
|
||
| ### Optional | ||
|
|
||
| - `api_version` (Number) Choose which version of the api you would like to use 1 or 2. Default is `2` | ||
| - `bearer_token` (String) The bearer token to be used to access harbor. Will take precedence over username and password if set | ||
| - `insecure` (Boolean) Choose to ignore certificate errors |
Oops, something went wrong.