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.

Sign up for GitHub

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

Fix links to data sources in bastionzero_db_target resource docs #72

Merged
merged 2 commits into from
Mar 26, 2024
Merged

Fix links to data sources in bastionzero_db_target resource docs #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0177228
Fix links to data sources
ymarcus93 Nov 16, 2023
31d2521
Add changie entry
ymarcus93 Mar 26, 2024
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: 5 additions & 0 deletions .changes/unreleased/NOTES-20240326-161540.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
kind: NOTES
body: Update `bastionzero_db_target` resource documentation
time: 2024-03-26T16:15:40.830302-04:00
custom:
Issues: "72"
2 changes: 1 addition & 1 deletion bastionzero/target/dbtarget/dbtarget.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ func makeDbTargetResourceSchema(ctx context.Context) map[string]resource_schema.
"proxy_target_id": resource_schema.StringAttribute{
Optional: true,
Description: "The target's proxy target's ID (ID of a Linux, Windows, or Kubernetes target).",
MarkdownDescription: "The target's proxy target's ID (ID of a [Linux](bzero_target), [Windows](bzero_target), or [Kubernetes](cluster_target) target).",
MarkdownDescription: "The target's proxy target's ID (ID of a [Linux](../data-sources/bzero_target), [Windows](../data-sources/bzero_target), or [Kubernetes](../data-sources/cluster_target) target).",
Validators: []validator.String{
bzvalidator.ValidUUIDV4(),
},
Expand Down
2 changes: 1 addition & 1 deletion bastionzero/target/dbtarget/resource_dbtarget.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ func (r *dbTargetResource) Metadata(_ context.Context, req resource.MetadataRequ
// Schema defines the schema for the db target resource.
func (r *dbTargetResource) Schema(ctx context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: "Provides a BastionZero database target. Database targets configure remote access to database servers running on [Linux](bzero_target), [Windows](bzero_target), or [Kubernetes](cluster_target) targets.",
MarkdownDescription: "Provides a BastionZero database target. Database targets configure remote access to database servers running on [Linux](../data-sources/bzero_target), [Windows](../data-sources/bzero_target), or [Kubernetes](../data-sources/cluster_target) targets.",
Attributes: makeDbTargetResourceSchema(ctx),
}
}
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/db_target.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
page_title: "bastionzero_db_target Resource - terraform-provider-bastionzero"
subcategory: "Target"
description: |-
Provides a BastionZero database target. Database targets configure remote access to database servers running on Linux bzero_target, Windows bzero_target, or Kubernetes cluster_target targets.
Provides a BastionZero database target. Database targets configure remote access to database servers running on Linux ../data-sources/bzero_target, Windows ../data-sources/bzero_target, or Kubernetes ../data-sources/cluster_target targets.
---

# bastionzero_db_target (Resource)

Provides a BastionZero database target. Database targets configure remote access to database servers running on [Linux](bzero_target), [Windows](bzero_target), or [Kubernetes](cluster_target) targets.
Provides a BastionZero database target. Database targets configure remote access to database servers running on [Linux](../data-sources/bzero_target), [Windows](../data-sources/bzero_target), or [Kubernetes](../data-sources/cluster_target) targets.

Learn more about Db targets [here](https://docs.bastionzero.com/docs/deployment/installing-the-agent#databases).

Expand All @@ -30,8 +30,8 @@ configuration is used.
-> **Note** If you don't know what combination of values to use for
[`database_authentication_config`](#database_authentication_config), then you
can use the
[`bastionzero_supported_database_configs`](supported_database_configs) data
source to get a list of supported values.
[`bastionzero_supported_database_configs`](../data-sources/supported_database_configs)
data source to get a list of supported values.

~> **Warning** _Modifying_ a Db target's
[`database_authentication_config.authentication_type`](#authentication_type)
Expand Down Expand Up @@ -232,7 +232,7 @@ resource "bastionzero_db_target" "example" {
- `database_authentication_config` (Attributes) Information about the db target's database authentication configuration. If this attribute is left unconfigured, the target is configured with the default, non-passwordless database configuration. (see [below for nested schema](#nestedatt--database_authentication_config))
- `local_port` (Number) The port of the Db daemon's localhost server that is spawned on the user's machine on connect. If this attribute is left unconfigured, an available port will be chosen when the target is connected to.
- `proxy_environment_id` (String) The target's proxy environment's ID (ID of the backing proxy environment).
- `proxy_target_id` (String) The target's proxy target's ID (ID of a [Linux](bzero_target), [Windows](bzero_target), or [Kubernetes](cluster_target) target).
- `proxy_target_id` (String) The target's proxy target's ID (ID of a [Linux](../data-sources/bzero_target), [Windows](../data-sources/bzero_target), or [Kubernetes](../data-sources/cluster_target) target).

### Read-Only

Expand Down
4 changes: 2 additions & 2 deletions templates/resources/db_target.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ configuration is used.
-> **Note** If you don't know what combination of values to use for
[`database_authentication_config`](#database_authentication_config), then you
can use the
[`bastionzero_supported_database_configs`](supported_database_configs) data
source to get a list of supported values.
[`bastionzero_supported_database_configs`](../data-sources/supported_database_configs)
data source to get a list of supported values.

~> **Warning** _Modifying_ a Db target's
[`database_authentication_config.authentication_type`](#authentication_type)
Expand Down