Skip to content

Commit

Permalink
docs: add warning to application template for config
Browse files Browse the repository at this point in the history
Requested in GH issue #393.
  • Loading branch information
hmlanigan committed Nov 14, 2024
1 parent a31d122 commit bef5faf
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/resources/application.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
# generated using template templates/resources/application.md.tmpl
page_title: "juju_application Resource - terraform-provider-juju"
subcategory: ""
description: |-
Expand All @@ -11,7 +11,6 @@ description: |-
A resource that represents a single Juju application deployment from a charm. Deployment of bundles is not supported.

## Example Usage

```terraform
resource "juju_application" "this" {
name = "my-application"
Expand Down Expand Up @@ -124,6 +123,12 @@ Read-Only:
- `pool` (String) Name of the storage pool.
- `size` (String) The size of each volume.


### Notes

Removing the config map will not reset the charm config to defaults per [GH issue #393](https://github.com/juju/terraform-provider-juju/issues/393)


## Import

Import is supported using the following syntax:
Expand Down
32 changes: 32 additions & 0 deletions templates/resources/application.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
# generated using template templates/resources/application.md.tmpl
page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: ""
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

{{ .Description | trimspace }}

{{ if .HasExample -}}
## Example Usage
{{tffile "examples/resources/juju_application/resource.tf"}}
{{- end }}

{{ .SchemaMarkdown | trimspace }}


### Notes

Removing the config map will not reset the charm config to defaults per [GH issue #393](https://github.com/juju/terraform-provider-juju/issues/393)


{{ if .HasImport -}}
## Import

Import is supported using the following syntax:

{{codefile "shell" "examples/resources/juju_application/import.sh"}}
{{- end }}

0 comments on commit bef5faf

Please sign in to comment.