Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
krystian-panek-vmltech committed Nov 14, 2023
1 parent ca6a250 commit 49098b3
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 61 deletions.
24 changes: 0 additions & 24 deletions docs/data-sources/example.md

This file was deleted.

25 changes: 0 additions & 25 deletions docs/resources/example.md

This file was deleted.

47 changes: 42 additions & 5 deletions docs/resources/instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ AEM Instance resource

- `client` (Block, Optional) (see [below for nested schema](#nestedblock--client))
- `compose` (Block, Optional) (see [below for nested schema](#nestedblock--compose))
- `files` (Map of String) Files or directories to be copied into the machine
- `system` (Block, Optional) (see [below for nested schema](#nestedblock--system))

### Read-Only

- `instances` (Attributes List) (see [below for nested schema](#nestedatt--instances))

<a id="nestedblock--client"></a>
### Nested Schema for `client`
Expand All @@ -28,14 +34,45 @@ 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

Optional:

- `credentials` (Map of String, Sensitive) Credentials for the connection type


<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
- `config` (String) Contents of the AEM Compose YML configuration file.
- `create_script` (String) Creates the instance or restores from backup. Forces instance recreation if changed.
- `delete_script` (String) Deletes the instance.
- `download` (Boolean) Toggle automatic AEM Compose CLI wrapper download. If set to false, assume the wrapper is present in the data directory.
- `launch_script` (String) Configures launched instance. Must be idempotent as it is executed always when changed. Typically used for setting up replication agents, installing service packs, etc.
- `version` (String) Version of AEM Compose tool to use on remote AEM machine.


<a id="nestedblock--system"></a>
### Nested Schema for `system`

Optional:

- `bootstrap_script` (String) Script executed once after connecting to the instance. Typically used for: providing AEM library files (quickstart.jar, license.properties, service packs), mounting data volume, etc. Forces instance recreation if changed.
- `data_dir` (String) Remote root path in which AEM Compose files and unpacked instances will be stored
- `env` (Map of String) Environment variables for AEM instances
- `service_config` (String) Contents of the AEM 'systemd' service definition file
- `user` (String) System user under which AEM instance will be running. By default, the same as the user used to connect to the machine.
- `work_dir` (String) Remote root path in which AEM Compose TF provider temporary files will be stored


<a id="nestedatt--instances"></a>
### Nested Schema for `instances`

Read-Only:

- `aem_version` (String)
- `attributes` (List of String)
- `dir` (String)
- `id` (String)
- `run_modes` (List of String)
- `url` (String)
2 changes: 1 addition & 1 deletion examples/aws_ssm/aem.tf
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ resource "aem_instance" "single" {
depends_on = [aws_instance.aem_single]

client {
type = "aws_ssm"
type = "aws_ssm"
settings = {
instance_id = aws_instance.aem_single.id
}
Expand Down
2 changes: 1 addition & 1 deletion examples/aws_ssm/aws.tf
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ resource "aws_iam_role" "aem_ec2" {
}
}
EOF
tags = local.tags
tags = local.tags
}

resource "aws_iam_role_policy_attachment" "ssm" {
Expand Down
2 changes: 1 addition & 1 deletion examples/ssh/aem.tf
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ resource "aem_instance" "single" {
depends_on = [aws_instance.aem_single, aws_volume_attachment.aem_single_data]

client {
type = "ssh"
type = "ssh"
settings = {
host = aws_instance.aem_single.public_ip
port = 22
Expand Down
8 changes: 4 additions & 4 deletions examples/ssh/aws.tf
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ resource "aws_instance" "aem_single" {

resource "aws_ebs_volume" "aem_single_data" {
availability_zone = aws_instance.aem_single.availability_zone
size = 128
type = "gp2"
tags = local.tags
size = 128
type = "gp2"
tags = local.tags
}

resource "aws_volume_attachment" "aem_single_data" {
Expand Down Expand Up @@ -48,7 +48,7 @@ resource "aws_iam_role" "aem_ec2" {
}
}
EOF
tags = local.tags
tags = local.tags
}

resource "aws_iam_role_policy_attachment" "s3" {
Expand Down

0 comments on commit 49098b3

Please sign in to comment.