Docs

wttech · Aug 27, 2023 · 4061c75 · 4061c75
1 parent ca2827d
commit 4061c75
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 38 deletions.
diff --git a/docs/data-sources/scaffolding_example.md → docs/data-sources/example.md b/docs/data-sources/scaffolding_example.md → docs/data-sources/example.md
@@ -1,6 +1,6 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "aem_example Data Source - terraform-provider-aem-framework"
+page_title: "aem_example Data Source - terraform-provider-aem"
 subcategory: ""
 description: |-
   Example data source
@@ -10,13 +10,7 @@ description: |-
 
 Example data source
 
-## Example Usage
 
-```terraform
-data "aem_example" "example" {
-  configurable_attribute = "some-value"
-}
-```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/docs/index.md b/docs/index.md
@@ -1,22 +1,16 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "AEM Provider"
+page_title: "aem Provider"
 subcategory: ""
 description: |-
   
 ---
 
-# AEM Provider
+# aem Provider
 
 
 
-## Example Usage
 
-```terraform
-provider "aem" {
-  # example configuration here
-}
-```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/docs/resources/scaffolding_example.md → docs/resources/example.md b/docs/resources/scaffolding_example.md → docs/resources/example.md
@@ -1,6 +1,6 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "aem_example Resource - terraform-provider-aem-framework"
+page_title: "aem_example Resource - terraform-provider-aem"
 subcategory: ""
 description: |-
   Example resource
@@ -10,13 +10,7 @@ description: |-
 
 Example resource
 
-## Example Usage
 
-```terraform
-resource "aem_example" "example" {
-  configurable_attribute = "some-value"
-}
-```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/docs/resources/instance.md b/docs/resources/instance.md
@@ -0,0 +1,41 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "aem_instance Resource - terraform-provider-aem"
+subcategory: ""
+description: |-
+  AEM Instance resource
+---
+
+# aem_instance (Resource)
+
+AEM Instance resource
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `client` (Block, Optional) (see [below for nested schema](#nestedblock--client))
+- `compose` (Block, Optional) (see [below for nested schema](#nestedblock--compose))
+
+<a id="nestedblock--client"></a>
+### Nested Schema for `client`
+
+Required:
+
+- `settings` (Map of String) Settings for the connection type
+- `type` (String) Type of connection to use to connect to the machine on which AEM instance will be running
+
+
+<a id="nestedblock--compose"></a>
+### Nested Schema for `compose`
+
+Optional:
+
+- `config_file` (String) Local path to the AEM configuration file
+- `data_dir` (String) Remote path in which AEM Compose data will be stored
+- `instance_id` (String) ID of the AEM instance to use (one of the instances defined in the configuration file)
+- `lib_dir` (String) Local path to directory from which AEM library files will be copied to the remote AEM machine
+- `version` (String) Version of AEM Compose tool to use on remote AEM machine
diff --git a/examples/minimal/main.tf b/examples/minimal/main.tf
@@ -18,31 +18,31 @@ provider "aem" {}
 
 locals {
   workspace = "aemc"
-  env_type = "aem-single"
-  host = "aem_single"
+  env_type  = "aem-single"
+  host      = "aem_single"
 
-  ssh_user = "ec2-user"
+  ssh_user        = "ec2-user"
   ssh_private_key = file("ec2-key.cer")
 
   tags = {
     Workspace = "aemc"
-    Env = "tf-minimal"
-    EnvType = "aem-single"
-    Host = "aem-single"
-    Name = "${local.workspace}_${local.env_type}_${local.host}"
+    Env       = "tf-minimal"
+    EnvType   = "aem-single"
+    Host      = "aem-single"
+    Name      = "${local.workspace}_${local.env_type}_${local.host}"
   }
 }
 
 resource "aws_instance" "aem_author" {
-  ami = "ami-043e06a423cbdca17" // RHEL 8
-  instance_type = "m5.xlarge"
+  ami                         = "ami-043e06a423cbdca17" // RHEL 8
+  instance_type               = "m5.xlarge"
   associate_public_ip_address = true
 
   tags = local.tags
 }
 
 output "instance_ip" {
-  value =  aws_instance.aem_author.public_ip
+  value = aws_instance.aem_author.public_ip
 }
 
 resource "aem_instance" "author" {
@@ -51,16 +51,16 @@ resource "aem_instance" "author" {
   client {
     type = "ssh"
     settings = {
-      host = aws_instance.aem_author.public_ip
-      port = 22
-      user = "ec2-user"
+      host        = aws_instance.aem_author.public_ip
+      port        = 22
+      user        = "ec2-user"
       private_key = local.ssh_private_key // TODO hide it in TF console outputs
     }
   }
   compose {
-    data_dir = "/data/aemc"
-    version = "1.4.1"
-    lib_dir = "lib"
+    data_dir    = "/data/aemc"
+    version     = "1.4.1"
+    lib_dir     = "lib"
     config_file = "aem.yml"
     instance_id = "local_author"
   }