Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fixed some variable names mismatches.
  • Loading branch information
kristianiliev1 authored May 20, 2024
1 parent 8a0cfcd commit 6e04574
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ By configuring these variables accordingly you enforce GraphDB accessibility sol

**Logging**

To enable the logging feature the first thing that you should do is to switch the `deploy_logging` variable to `true`.
To enable the logging feature the first thing that you should do is to switch the `deploy_logging_module` variable to `true`.

There are several logging features that can be enabled with the following variables:

Expand All @@ -284,16 +284,16 @@ There are several logging features that can be enabled with the following variab
To enable the S3 Bucket access logs for the backup bucket you should switch the following values to `true`:

```hcl
deploy_logging = true
s3_access_logs_lifecycle_rule_status = true
deploy_logging_module = true
s3_access_logs_lifecycle_rule_status = "Enabled"
s3_enable_access_logs = true
```

#### Load Balancer Access Logs

To enable the load balancer logs you should enable the following variables to `true`:
```hcl
deploy_logging = true
deploy_logging_module = true
lb_access_logs_lifecycle_rule_status = true
lb_enable_access_logs = true
```
Expand All @@ -303,9 +303,9 @@ lb_enable_access_logs = true
To enable the VPC Flow logs you should switch the following variables to `true`:

```hcl
deploy_logging = true
deploy_logging_module = true
vpc_enable_flow_logs = true
vpc_flow_logs_lifecycle_rule_status = true
vpc_flow_logs_lifecycle_rule_status = "Enabled"
```

#### Replication
Expand All @@ -316,7 +316,7 @@ To do so you should switch the following variables to true:

```hcl
logging_enable_bucket_replication = true
s3_enable_replication_rule = true
s3_enable_replication_rule = "Enabled"
```

## Updating configurations on an active deployment
Expand All @@ -343,7 +343,7 @@ Support for this will be introduced in the future.

### Upgrading GraphDB Version

To automatically update the GraphDB version with `terraform apply`, you need to set `enable_instance_refresh` to `true`
To automatically update the GraphDB version with `terraform apply`, you need to set `asg_enable_instance_refresh` to `true`
in your `tfvars` file. This configuration will refresh your already running instances with new ones,
replacing them one at a time.

Expand All @@ -355,11 +355,11 @@ It's important to note that if you have made changes to any GraphDB configuratio
they will be applied during the instance refresh process with the exception for the `graphdb_admin_password`.
Support for this will be introduced in the future.

**Important:** Having `enable_instance_refresh` enabled when scaling up the GraphDB cluster may lead to data
**Important:** Having `asg_enable_instance_refresh` enabled when scaling up the GraphDB cluster may lead to data
replication issues, as existing instances will still undergo the refresh process.
Depending on the data size, the new nodes might fail in joining the cluster due to the instance refresh.

**We strongly recommend you to set `enable_instance_refresh` to `false` when scaling up the cluster.**
**We strongly recommend you to set `asg_enable_instance_refresh` to `false` when scaling up the cluster.**

## Local Development

Expand Down

0 comments on commit 6e04574

Please sign in to comment.