-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make tpgtools generate beta docs into GA as well for parity with mmv1. (
#5325) (#10545) * Make tpgtools generate beta docs into GA as well for parity with mmv1. Also, minor changes to make sure that the docs are a little bit better - allow overrides of documentation values, for instance. Also, includes the actual description of the resource, which, at the moment is not acceptable in the DCL. Will need to implement an override in the DCL. * Generate reasonable documentation for autogenerated and handwritten tests. * Default to - instead of _ * Improve documentation further with links and guides. Signed-off-by: Modular Magician <[email protected]>
- Loading branch information
1 parent
d076ab2
commit 82e5f7e
Showing
13 changed files
with
158 additions
and
41 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,3 @@ | ||
| ```release-note:bug | ||
| all: fixed an issue where some documentation for new resources was not showing up in the GA provider if it was beta-only. | ||
| ``` |
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
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 |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| --- | ||
| # ---------------------------------------------------------------------------- | ||
| # | ||
| # *** AUTO GENERATED CODE *** Type: DCL *** | ||
| # | ||
| # ---------------------------------------------------------------------------- | ||
| # | ||
| # This file is managed by Magic Modules (https:#github.com/GoogleCloudPlatform/magic-modules) | ||
| # and is based on the DCL (https:#github.com/GoogleCloudPlatform/declarative-resource-client-library). | ||
| # Changes will need to be made to the DCL or Magic Modules instead of here. | ||
| # | ||
| # We are not currently able to accept contributions to this file. If changes | ||
| # are required, please file an issue at https:#github.com/hashicorp/terraform-provider-google/issues/new/choose | ||
| # | ||
| # ---------------------------------------------------------------------------- | ||
| subcategory: "Cloud (Stackdriver) Monitoring" | ||
| layout: "google" | ||
| page_title: "Google: google_monitoring_monitored_project" | ||
| sidebar_current: "docs-google-monitoring-monitored-project" | ||
| description: |- | ||
| Beta only: Monitored Project allows you to set a project as monitored by a _metrics scope_, which is a term for a project used to group the metrics of multiple projects, potentially across multiple organizations. This enables you to view these groups in the Monitoring page of the cloud console. | ||
| --- | ||
|
|
||
| # google\_monitoring\_monitored\_project | ||
|
|
||
| Beta only: Monitored Project allows you to set a project as monitored by a _metrics scope_, which is a term for a project used to group the metrics of multiple projects, potentially across multiple organizations. This enables you to view these groups in the Monitoring page of the cloud console. | ||
|
|
||
| For more information, see: | ||
| * [Understanding metrics scopes](https://cloud.google.com/monitoring/settings#concept-scope) | ||
| * [API notes](https://cloud.google.com/monitoring/settings/manage-api) | ||
| ## Example Usage - basic_monitored_project | ||
| A basic example of a monitoring monitored project | ||
| ```hcl | ||
| resource "google_monitoring_monitored_project" "primary" { | ||
| metrics_scope = "existing-metrics-scope-project" | ||
| name = google_project.basic.name | ||
| provider = google-beta | ||
| } | ||
| resource "google_project" "basic" { | ||
| project_id = "my-monitored-project" | ||
| name = "my-monitored-project" | ||
| org_id = "123456789" | ||
| provider = google-beta | ||
| } | ||
| ``` | ||
|
|
||
| ## Argument Reference | ||
|
|
||
| The following arguments are supported: | ||
|
|
||
| * `metrics_scope` - | ||
| (Required) | ||
| Required. The resource name of the existing Metrics Scope that will monitor this project. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER} | ||
|
|
||
| * `name` - | ||
| (Required) | ||
| Immutable. The resource name of the `MonitoredProject`. On input, the resource name includes the scoping project ID and monitored project ID. On output, it contains the equivalent project numbers. Example: `locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}` | ||
|
|
||
|
|
||
|
|
||
| - - - | ||
|
|
||
|
|
||
|
|
||
| ## Attributes Reference | ||
|
|
||
| In addition to the arguments listed above, the following computed attributes are exported: | ||
|
|
||
| * `id` - an identifier for the resource with format `locations/global/metricsScopes/{{metrics_scope}}/projects/{{name}}` | ||
|
|
||
| * `create_time` - | ||
| Output only. The time when this `MonitoredProject` was created. | ||
|
|
||
| ## Timeouts | ||
|
|
||
| This resource provides the following | ||
| [Timeouts](/docs/configuration/resources.html#timeouts) configuration options: | ||
|
|
||
| - `create` - Default is 10 minutes. | ||
| - `delete` - Default is 10 minutes. | ||
|
|
||
| ## Import | ||
|
|
||
| MonitoredProject can be imported using any of these accepted formats: | ||
|
|
||
| ``` | ||
| $ terraform import google_monitoring_monitored_project.default locations/global/metricsScopes/{{metrics_scope}}/projects/{{name}} | ||
| $ terraform import google_monitoring_monitored_project.default {{metrics_scope}}/{{name}} | ||
| ``` | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.