Update documentation and add examples (#16)

Author: HorizonNet

.editorconfig

@@ -20,7 +20,7 @@ indent_style = space
 max_line_length = off
 
 [*.md]
-max_line_length = 0
+max_line_length = off
 trim_trailing_whitespace = false
 
 [*.yml]

.github/workflows/trivy.yml

@@ -28,3 +28,4 @@ jobs:
           format: 'table'
           exit-code: '1'
           hide-progress: false
+          skip-dirs: 'examples'

README.md

@@ -1,3 +1,42 @@
 # AWS Secure S3 Terraform module
 
 Terraform module which creates a S3 bucket on AWS with secure defaults.
+
+## Usage
+
+The simplest usage of this module is shown below. It only requires to pass in the `bucket_name`.
+
+```hcl
+module "terraform_state_s3_bucket" {
+  source  = "ultratendency/secure-s3-bucket/aws"
+  version = "1.0.0"
+
+  bucket_name = "secure-bucket"
+}
+```
+
+A complete example looks like the following, where all inputs are configured.
+
+```hcl
+module "terraform_state_s3_bucket" {
+  source  = "ultratendency/secure-s3-bucket/aws"
+  version = "1.0.0"
+
+  bucket_name = "secure-bucket"
+
+  bucket_lifecycle_configuration_rule_noncurrent_version_expiration_noncurrent_days           = 45
+  bucket_lifecycle_configuration_rule_noncurrent_version_first_transition_noncurrent_days     = 15
+  bucket_lifecycle_configuration_rule_noncurrent_version_first_transition_storage_class       = "ONEZONE_IA"
+  bucket_lifecycle_configuration_rule_noncurrent_version_second_transition_noncurrent_days    = 30
+  bucket_lifecycle_configuration_rule_noncurrent_version_second_transition_storage_class      = "GLACIER_IR"
+  bucket_lifecycle_configuration_rule_abort_incomplete_multipart_upload_days_after_initiation = 14
+
+  aws_kms_key_enable_key_rotation = false
+  aws_kms_key_multi_region        = true
+
+  aws_s3_bucket_public_access_block_block_public_acls       = false
+  aws_s3_bucket_public_access_block_block_public_policy     = false
+  aws_s3_bucket_public_access_block_ignore_public_acls      = false
+  aws_s3_bucket_public_access_block_restrict_public_buckets = false
+}
+```

checkov-config.yml

@@ -6,3 +6,5 @@ skip-check:
   - CKV_AWS_18
   - CKV_AWS_144
   - CKV2_AWS_62
+  # As we're using the Terraform Registry
+  - CKV_TF_1

examples/complete/README.md

@@ -0,0 +1,17 @@
+# Complete bucket
+
+The configuration in this directory creates a S3 bucket with all input set to different values
+than the defaults.
+
+## Usage
+
+To run this example you need to execute:
+
+```bash
+terraform init
+terraform plan
+terraform apply
+```
+
+Note that this example may create resources which can cost money (AWS Elastic IP, for example).
+Run `terraform destroy`` when you don't need these resources.

examples/complete/main.tf

@@ -0,0 +1,25 @@
+provider "aws" {
+  region = "eu-central-1"
+}
+
+module "terraform_state_s3_bucket" {
+  source  = "ultratendency/secure-s3-bucket/aws"
+  version = "1.0.0"
+
+  bucket_name = "secure-bucket"
+
+  bucket_lifecycle_configuration_rule_noncurrent_version_expiration_noncurrent_days           = 45
+  bucket_lifecycle_configuration_rule_noncurrent_version_first_transition_noncurrent_days     = 15
+  bucket_lifecycle_configuration_rule_noncurrent_version_first_transition_storage_class       = "ONEZONE_IA"
+  bucket_lifecycle_configuration_rule_noncurrent_version_second_transition_noncurrent_days    = 30
+  bucket_lifecycle_configuration_rule_noncurrent_version_second_transition_storage_class      = "GLACIER_IR"
+  bucket_lifecycle_configuration_rule_abort_incomplete_multipart_upload_days_after_initiation = 14
+
+  aws_kms_key_enable_key_rotation = false
+  aws_kms_key_multi_region        = true
+
+  aws_s3_bucket_public_access_block_block_public_acls       = false
+  aws_s3_bucket_public_access_block_block_public_policy     = false
+  aws_s3_bucket_public_access_block_ignore_public_acls      = false
+  aws_s3_bucket_public_access_block_restrict_public_buckets = false
+}

examples/complete/versions.tf

@@ -0,0 +1,10 @@
+terraform {
+  required_version = ">= 1.0"
+
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 5.0"
+    }
+  }
+}

examples/simple/README.md

@@ -0,0 +1,16 @@
+# Simple bucket
+
+The configuration in this directory creates a S3 bucket with all default values.
+
+## Usage
+
+To run this example you need to execute:
+
+```bash
+terraform init
+terraform plan
+terraform apply
+```
+
+Note that this example may create resources which can cost money (AWS Elastic IP, for example).
+Run `terraform destroy`` when you don't need these resources.

examples/simple/main.tf

@@ -0,0 +1,10 @@
+provider "aws" {
+  region = "eu-central-1"
+}
+
+module "terraform_state_s3_bucket" {
+  source  = "ultratendency/secure-s3-bucket/aws"
+  version = "1.0.0"
+
+  bucket_name = "secure-bucket"
+}

examples/simple/versions.tf

@@ -0,0 +1,10 @@
+terraform {
+  required_version = ">= 1.0"
+
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 5.0"
+    }
+  }
+}