Skip to content

Commit

Permalink
Merge pull request #20 from sourcefuse/feature/update-document
Browse files Browse the repository at this point in the history
Updated Docs
  • Loading branch information
mayank0202 committed Feb 23, 2024
1 parent dd30b53 commit 62b4955
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions docs/arc-iac-docs/modules/terraform-aws-cloud-custodian/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,29 @@

The purpose of this module is to provide a Terraform based interface for administering Cloud Custodian to assist with managing the state of template files and to allow for easier runtime interpolation via Terraform.

## Requirements
For more information about this repository and its usage, please see [Terraform AWS ARC GitHub CLOUD CUSTODIAN Module Usage Guide](https://github.com/sourcefuse/terraform-aws-arc-cloud-custodian/blob/main/docs/module-usage-guide/README.md).


## Requirements

```shell
Terraform >= 1.0.5
Pip >= 20.0.2
Python >= 3.8
```
Terraform >= 1.0.5
Pip >= 20.0.2
Python >= 3.8
```

## Getting started
## Getting started
You must have Python 3.8 or above installed.

To install Cloud Custodian, you can download it using Pip:

```shell
pip install c7n
pip install c7n
```
* Pip package notes
* c7n is for AWS
* c7n_azure us for Azure
* c7n_gcp is for Google Compute
* c7n_gcp is for Google Compute

## Usage
```hcl
Expand Down Expand Up @@ -173,10 +176,10 @@ module "cloud_custodian" {
| <a name="output_sqs_arn"></a> [sqs\_arn](#output\_sqs\_arn) | ARN of the SQS queue |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

## Versioning
This project uses a `.version` file at the root of the repo which the pipeline reads from and does a git tag.
## Versioning
This project uses a `.version` file at the root of the repo which the pipeline reads from and does a git tag.

On commits to `main`, you will need to increment this version. Once the project is merged, the pipeline will kick off and tag the latest git commit.
On commits to `main`, you will need to increment this version. Once the project is merged, the pipeline will kick off and tag the latest git commit.

## Development

Expand All @@ -187,7 +190,7 @@ Install the prerequisites:
* [terraform](https://learn.hashicorp.com/terraform/getting-started/install#installing-terraform)
* [terraform-docs](https://github.com/segmentio/terraform-docs)

Then run `pre-commit` on the repo:
Then run `pre-commit` on the repo:

```shell
pre-commit install
Expand All @@ -196,5 +199,5 @@ pre-commit run --all-files

## Authors

This project is authored by:
This project is authored by:
* SourceFuse ARC Team

0 comments on commit 62b4955

Please sign in to comment.