Skip to content

Commit

Permalink
docs: permissions if local-id is set
Browse files Browse the repository at this point in the history
  • Loading branch information
malhussan committed Feb 12, 2025
1 parent 64f3d16 commit 127a6e6
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 5 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ jobs:
with:
go-version-file: 'go.mod'
cache: true
- uses: hashicorp/setup-terraform@v2
with:
terraform_wrapper: false
- run: go generate ./...
- name: git diff
run: |
Expand Down
6 changes: 3 additions & 3 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ linters:
enable:
- durationcheck
- errcheck
- exportloopref
- copyloopvar
- forcetypeassert
- godot
- gofmt
Expand All @@ -20,8 +20,8 @@ linters:
- nilerr
- predeclared
- staticcheck
- tenv
- usetesting
- unconvert
- unparam
- unused
- vet
- govet
2 changes: 1 addition & 1 deletion docs/resources/tenant.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Read-Only:
Optional:

- `landing_zone_identifier` (String) Identifier of landing zone to assign to this tenant.
- `local_id` (String) Tenant ID local to the platform (e.g. GCP project ID, Azure subscription ID). Setting the local ID means that a tenant with this ID should be imported into meshStack. Not setting a local ID means that a new tenant should be created. Field will be empty until a successful replication has run.
- `local_id` (String) Tenant ID local to the platform (e.g. GCP project ID, Azure subscription ID). Setting the local ID means that a tenant with this ID should be imported into meshStack. Not setting a local ID means that a new tenant should be created. Field will be empty until a successful replication has run. **Note:** Importing is a high-privileged operation and setting this field is possible only when using API Keys with admin permissions for saving tenants.
- `quotas` (Attributes List) Set of applied tenant quotas. By default the landing zone quotas are applied to new tenants. (see [below for nested schema](#nestedatt--spec--quotas))

<a id="nestedatt--spec--quotas"></a>
Expand Down
2 changes: 1 addition & 1 deletion internal/provider/tenant_resource.go
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ func (r *tenantResource) Schema(_ context.Context, _ resource.SchemaRequest, res
PlanModifiers: []planmodifier.Object{objectplanmodifier.RequiresReplace()},
Attributes: map[string]schema.Attribute{
"local_id": schema.StringAttribute{
MarkdownDescription: "Tenant ID local to the platform (e.g. GCP project ID, Azure subscription ID). Setting the local ID means that a tenant with this ID should be imported into meshStack. Not setting a local ID means that a new tenant should be created. Field will be empty until a successful replication has run.",
MarkdownDescription: "Tenant ID local to the platform (e.g. GCP project ID, Azure subscription ID). Setting the local ID means that a tenant with this ID should be imported into meshStack. Not setting a local ID means that a new tenant should be created. Field will be empty until a successful replication has run. **Note:** Importing is a high-privileged operation and setting this field is possible only when using API Keys with admin permissions for saving tenants.",
Optional: true,
Computed: true,
},
Expand Down

0 comments on commit 127a6e6

Please sign in to comment.