Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

techdebt: [CDS-82834]: Improve GitOps Docs #737

Merged
merged 2 commits into from
Nov 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/resources/platform_gitops_agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,12 @@ Optional:
Import is supported using the following syntax:

```shell
# Import a Account level Gitops Agent
# Import an Account level Gitops Agent
terraform import harness_platform_gitops_agent.example <agent_id>

# Import an Org level Gitops Agent
terraform import harness_platform_gitops_agent.example <organization_id>/<agent_id>

# Import a Project level Gitops Agent
terraform import harness_platform_gitops_agent.example <organization_id>/<project_id>/<agent_id>
```
5 changes: 4 additions & 1 deletion docs/resources/platform_gitops_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,9 +270,12 @@ Optional:
Import is supported using the following syntax:

```shell
# Import a Account level Gitops Cluster
# Import an Account level Gitops Cluster
terraform import harness_platform_gitops_cluster.example <agent_id>/<cluster_id>

# Import an Org level Gitops Cluster
terraform import harness_platform_gitops_cluster.example <organization_id>/<agent_id>/<cluster_id>

# Import a Project level Gitops Cluster
terraform import harness_platform_gitops_cluster.example <organization_id>/<project_id>/<agent_id>/<cluster_id>
```
7 changes: 5 additions & 2 deletions docs/resources/platform_gitops_gnupg.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,12 @@ Read-Only:
Import is supported using the following syntax:

```shell
# Import a Account level Gitops Cluster
# Import an Account level Gitops GnuPG Key
terraform import harness_platform_gitops_gnupg.example <agent_id>/<key_id>

# Import a Project level Gitops Cluster
# Import an Org level Gitops GnuPG Key
terraform import harness_platform_gitops_gnupg.example <organization_id>/<agent_id>/<key_id>

# Import a Project level Gitops GnuPG Key
terraform import harness_platform_gitops_gnupg.example <organization_id>/<project_id>/<agent_id>/<key_id>
```
8 changes: 7 additions & 1 deletion docs/resources/platform_gitops_repo_cert.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,12 @@ Optional:
Import is supported using the following syntax:

```shell
# Import a Account level Gitops Repository Certificate
# Import an Account level Gitops Repository Certificate
terraform import harness_platform_gitops_repo_cert.example <repocert_id>

# Import an Org level Gitops Repository Certificate
terraform import harness_platform_gitops_repo_cert.example <organization_id>/<repocert_id>

# Import a Project level Gitops Repository Certificate
terraform import harness_platform_gitops_repo_cert.example <organization_id>/<project_id>/<repocert_id>
```
5 changes: 4 additions & 1 deletion docs/resources/platform_gitops_repo_cred.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,12 @@ Optional:
Import is supported using the following syntax:

```shell
# Import a Account level Gitops Repository Credentials
# Import an Account level Gitops Repository Credentials
terraform import harness_platform_gitops_repo_cred.example <agent_id>/<repocred_id>

# Import an Org level Gitops Repository Credentials
terraform import harness_platform_gitops_repo_cred.example <organization_id>/<agent_id>/<repocred_id>

# Import a Project level Gitops Repository Credentials
terraform import harness_platform_gitops_repo_cred.example <organization_id>/<project_id>/<agent_id>/<repocred_id>
```
5 changes: 4 additions & 1 deletion docs/resources/platform_gitops_repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,12 @@ Optional:
Import is supported using the following syntax:

```shell
# Import a Account level Gitops Repository
# Import an Account level Gitops Repository
terraform import harness_platform_gitops_repository.example <agent_id>/<respository_id>

# Import an Org level Gitops Repository
terraform import harness_platform_gitops_repository.example <organization_id>/<agent_id>/<respository_id>

# Import a Project level Gitops Repository
terraform import harness_platform_gitops_repository.example <organization_id>/<project_id>/<agent_id>/<respository_id>
```
5 changes: 4 additions & 1 deletion examples/resources/harness_platform_gitops_agent/import.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Import a Account level Gitops Agent
# Import an Account level Gitops Agent
terraform import harness_platform_gitops_agent.example <agent_id>

# Import an Org level Gitops Agent
terraform import harness_platform_gitops_agent.example <organization_id>/<agent_id>

# Import a Project level Gitops Agent
terraform import harness_platform_gitops_agent.example <organization_id>/<project_id>/<agent_id>
7 changes: 5 additions & 2 deletions examples/resources/harness_platform_gitops_cluster/import.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Import a Account level Gitops Cluster
# Import an Account level Gitops Cluster
terraform import harness_platform_gitops_cluster.example <agent_id>/<cluster_id>

# Import an Org level Gitops Cluster
terraform import harness_platform_gitops_cluster.example <organization_id>/<agent_id>/<cluster_id>

# Import a Project level Gitops Cluster
terraform import harness_platform_gitops_cluster.example <organization_id>/<project_id>/<agent_id>/<cluster_id>
terraform import harness_platform_gitops_cluster.example <organization_id>/<project_id>/<agent_id>/<cluster_id>
9 changes: 6 additions & 3 deletions examples/resources/harness_platform_gitops_gnupg/import.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Import a Account level Gitops Cluster
# Import an Account level Gitops GnuPG Key
terraform import harness_platform_gitops_gnupg.example <agent_id>/<key_id>

# Import a Project level Gitops Cluster
terraform import harness_platform_gitops_gnupg.example <organization_id>/<project_id>/<agent_id>/<key_id>
# Import an Org level Gitops GnuPG Key
terraform import harness_platform_gitops_gnupg.example <organization_id>/<agent_id>/<key_id>

# Import a Project level Gitops GnuPG Key
terraform import harness_platform_gitops_gnupg.example <organization_id>/<project_id>/<agent_id>/<key_id>
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
# Import a Account level Gitops Repository Certificate
# Import an Account level Gitops Repository Certificate
terraform import harness_platform_gitops_repo_cert.example <repocert_id>

# Import an Org level Gitops Repository Certificate
terraform import harness_platform_gitops_repo_cert.example <organization_id>/<repocert_id>

# Import a Project level Gitops Repository Certificate
terraform import harness_platform_gitops_repo_cert.example <organization_id>/<project_id>/<repocert_id>
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Import a Account level Gitops Repository Credentials
# Import an Account level Gitops Repository Credentials
terraform import harness_platform_gitops_repo_cred.example <agent_id>/<repocred_id>

# Import an Org level Gitops Repository Credentials
terraform import harness_platform_gitops_repo_cred.example <organization_id>/<agent_id>/<repocred_id>

# Import a Project level Gitops Repository Credentials
terraform import harness_platform_gitops_repo_cred.example <organization_id>/<project_id>/<agent_id>/<repocred_id>
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Import a Account level Gitops Repository
# Import an Account level Gitops Repository
terraform import harness_platform_gitops_repository.example <agent_id>/<respository_id>

# Import an Org level Gitops Repository
terraform import harness_platform_gitops_repository.example <organization_id>/<agent_id>/<respository_id>

# Import a Project level Gitops Repository
terraform import harness_platform_gitops_repository.example <organization_id>/<project_id>/<agent_id>/<respository_id>
terraform import harness_platform_gitops_repository.example <organization_id>/<project_id>/<agent_id>/<respository_id>