Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maciaszczykm committed Nov 24, 2023
1 parent 2e6a6cc commit a8ee372
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 19 deletions.
8 changes: 4 additions & 4 deletions docs/data-sources/git_repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ GitRepository resource

### Optional

- `https_path` (String) Manually supplied https path for non standard git setups. This is auto-inferred in many cases.
- `https_path` (String) Manually supplied https path for non standard Git setups. This is auto-inferred in many cases.
- `passphrase` (String) Passphrase to decrypt the given private key.
- `password` (String) HTTP password for http authenticated repos.
- `private_key` (String) SSH private key to use with this repo if an ssh url was given.
- `url_format` (String) Similar to https_Path, a manually supplied url format for custom git. Should be something like {url}/tree/{ref}/{folder}.
- `username` (String) HTTP username for authenticated http repos, defaults to apiKey for GitHub.
- `private_key` (String) SSH private key to use with this repo if an SSH URL was given.
- `url_format` (String) Similar to `https_path`, a manually supplied url format for custom Git. Should be something like `{url}/tree/{ref}/{folder}`.
- `username` (String) HTTP username for authenticated HTTP repos, defaults to apiKey for GitHub.

### Read-Only

Expand Down
22 changes: 11 additions & 11 deletions docs/resources/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ A representation of a cluster you can deploy to.

- `bindings` (Attributes) Read and write policies of this cluster. (see [below for nested schema](#nestedatt--bindings))
- `handle` (String) A short, unique human-readable name used to identify this cluster. Does not necessarily map to the cloud resource name.
- `node_pools` (Attributes List) (see [below for nested schema](#nestedatt--node_pools))
- `node_pools` (Attributes List) List of node pool specs managed by this cluster. Leave empty for bring your own cluster. (see [below for nested schema](#nestedatt--node_pools))
- `protect` (Boolean) If set to `true` then this cluster cannot be deleted.
- `provider_id` (String)
- `provider_id` (String) Provider used to create this cluster. Leave empty for bring your own cluster.
- `tags` (Map of String) Key-value tags used to filter clusters.
- `version` (String)
- `version` (String) Desired Kubernetes version for this cluster. Leave empty for bring your own cluster.

### Read-Only

Expand Down Expand Up @@ -154,30 +154,30 @@ Optional:

Required:

- `instance_type` (String)
- `max_size` (Number)
- `min_size` (Number)
- `name` (String)
- `instance_type` (String) The type of node to use. Usually cloud-specific.
- `max_size` (Number) Maximum number of instances in this node pool.
- `min_size` (Number) Minimum number of instances in this node pool.
- `name` (String) Node pool name. Must be unique.

Optional:

- `cloud_settings` (Attributes) Cloud-specific settings for this node pool. (see [below for nested schema](#nestedatt--node_pools--cloud_settings))
- `labels` (Map of String)
- `taints` (Attributes List) (see [below for nested schema](#nestedatt--node_pools--taints))
- `labels` (Map of String) Kubernetes labels to apply to the nodes in this pool. Useful for node selectors.
- `taints` (Attributes List) Any taints you'd want to apply to a node, i.e. for preventing scheduling on spot instances. (see [below for nested schema](#nestedatt--node_pools--taints))

<a id="nestedatt--node_pools--cloud_settings"></a>
### Nested Schema for `node_pools.cloud_settings`

Optional:

- `aws` (Attributes) (see [below for nested schema](#nestedatt--node_pools--cloud_settings--aws))
- `aws` (Attributes) AWS node pool customizations. (see [below for nested schema](#nestedatt--node_pools--cloud_settings--aws))

<a id="nestedatt--node_pools--cloud_settings--aws"></a>
### Nested Schema for `node_pools.cloud_settings.aws`

Optional:

- `launch_template_id` (String)
- `launch_template_id` (String) Custom launch template for your nodes. Useful for Golden AMI setups.



Expand Down
8 changes: 4 additions & 4 deletions internal/datasource/git_repository.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ func (r *GitRepositoryDataSource) Schema(_ context.Context, _ datasource.SchemaR
Required: true,
},
"private_key": schema.StringAttribute{
MarkdownDescription: "SSH private key to use with this repo if an ssh url was given.",
MarkdownDescription: "SSH private key to use with this repo if an SSH URL was given.",
Validators: []validator.String{stringvalidator.ConflictsWith(path.MatchRoot("username"), path.MatchRoot("password"))},
Optional: true,
},
Expand All @@ -52,7 +52,7 @@ func (r *GitRepositoryDataSource) Schema(_ context.Context, _ datasource.SchemaR
Optional: true,
},
"username": schema.StringAttribute{
MarkdownDescription: "HTTP username for authenticated http repos, defaults to apiKey for GitHub.",
MarkdownDescription: "HTTP username for authenticated HTTP repos, defaults to apiKey for GitHub.",
Validators: []validator.String{stringvalidator.ConflictsWith(path.MatchRoot("private_key"), path.MatchRoot("passphrase"))},
Optional: true,
},
Expand All @@ -62,11 +62,11 @@ func (r *GitRepositoryDataSource) Schema(_ context.Context, _ datasource.SchemaR
Optional: true,
},
"url_format": schema.StringAttribute{
MarkdownDescription: "Similar to https_Path, a manually supplied url format for custom git. Should be something like {url}/tree/{ref}/{folder}.",
MarkdownDescription: "Similar to `https_path`, a manually supplied url format for custom Git. Should be something like `{url}/tree/{ref}/{folder}`.",
Optional: true,
},
"https_path": schema.StringAttribute{
MarkdownDescription: "Manually supplied https path for non standard git setups. This is auto-inferred in many cases.",
MarkdownDescription: "Manually supplied https path for non standard Git setups. This is auto-inferred in many cases.",
Optional: true,
},
},
Expand Down

0 comments on commit a8ee372

Please sign in to comment.