Skip to content

Commit 44e5ce4

Browse files
Updated module
1 parent 1ca1686 commit 44e5ce4

File tree

1 file changed

+7
-34
lines changed

1 file changed

+7
-34
lines changed

README.md

Lines changed: 7 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,13 @@
55

66
### [SquareOps Technologies](https://squareops.com/) Your DevOps Partner for Accelerating cloud journey.
77
<br>
8-
We publish several terraform modules.
9-
<br>
108
Terraform module to create Remote State Storage resources for workload deployment on AWS Cloud.
119

1210
## Usage Example
1311

1412
```hcl
1513
module "backend" {
16-
source = "gitlab.com/squareops/sal/terraform/aws/tfstate.git"
14+
source = "squareops/tfstate/aws"
1715
1816
environment = "Production"
1917
bucket_name = "tfstate"
@@ -23,8 +21,10 @@ module "backend" {
2321
}
2422
2523
```
24+
Refer [examples](https://github.com/squareops/terraform-aws-tfstate/tree/main/examples/state-storage-backend) for more details.
25+
2626
## IAM Permissions
27-
The required IAM permissions to create resources from this module can be found [here](https://gitlab.com/sq-ia/aws/tfstate/-/blob/v1.0.0/IAM.md)
27+
The required IAM permissions to create resources from this module can be found [here](https://github.com/squareops/terraform-aws-tfstate/blob/main/IAM.md)
2828

2929
## Important Note
3030
Terraform state locking is a mechanism used to prevent multiple users from simultaneously making changes to the same Terraform state, which could result in conflicts and data loss. A state lock is acquired and maintained by Terraform while it is making changes to the state, and other instances of Terraform are unable to make changes until the lock is released.
@@ -100,38 +100,11 @@ Security scanning is graciously provided by Prowler. Proowler is the leading ful
100100

101101
## Contribution & Issue Reporting
102102

103-
To contribute to a project, you can typically:
104-
105-
1. Find the repository on a platform like GitHub
106-
2. Fork the repository to your own account
107-
3. Make changes to the code
108-
4. Submit a pull request to the original repository
109-
110103
To report an issue with a project:
111104

112105
1. Check the repository's [issue tracker](https://github.com/squareops/terraform-aws-vpc/issues) on GitHub
113106
2. Search to see if the issue has already been reported
114-
3. If you can't find an answer to your question in the documentation or issue tracker, you can ask a question by creating a new issue. Be sure to provide enough context and details so others can understand your problem.
115-
4. Contributing to the project can be a great way to get involved and get help. The maintainers and other contributors may be more likely to help you if you're already making contributions to the project.
116-
117-
## Our Other Projects
118-
119-
We have a number of other projects that you might be interested in:
120-
121-
1. [terraform-aws-vpc](https://github.com/squareops/terraform-aws-vpc): Terraform module to create Networking resources for workload deployment on AWS Cloud.
122-
123-
2. [terraform-aws-keypair](https://github.com/squareops/terraform-aws-keypair): Terraform module which creates EC2 key pair on AWS. The private key will be stored on SSM.
124-
125-
Follow Us:
126-
127-
To stay updated on our projects and future release, follow us on
128-
[GitHub](https://github.com/squareops/),
129-
[LinkedIn](https://www.linkedin.com/company/squareops-technologies-pvt-ltd/)
130-
131-
By joining our both the [email](https://github.com/squareops) and [Slack community](https://github.com/squareops), you can benefit from the different ways in which we provide support. You can receive timely notifications and updates through email and engage in real-time conversations and discussions with other members through Slack. This combination of resources can help you stay informed, get help when you need it, and contribute to the project in a meaningful way.
132-
133-
## Security, Validation and pull-requests
134-
we have offered here high standard, quality code. Hence we are using several [pre-commit hooks](.pre-commit-config.yaml) and [GitHub Actions](https://gitlab.com/sq-ia/aws/eks/-/tree/v1.0.0#security-validation-and-pull-requests) as a workflow. So here we will create pull-requests to any branch and validate the request automatically using pre-commit tool.
107+
3. If you can't find an answer to your question in the documentation or issue tracker, you can ask a question by creating a new issue. Make sure to provide enough context and details .
135108

136109
## License
137110

@@ -141,9 +114,9 @@ Apache License, Version 2.0, January 2004 (http://www.apache.org/licenses/).
141114

142115
To support a GitHub project by liking it, you can follow these steps:
143116

144-
1. Visit the repository: Navigate to the GitHub repository.
117+
1. Visit the repository: Navigate to the [GitHub repository](https://github.com/squareops/terraform-aws-tfstate)
145118

146-
2. Click the "Star" [button](https://github.com/squareops/terraform-aws-vpc): On the repository page, you'll see a "Star" button in the upper right corner. Clicking on it will star the repository, indicating your support for the project.
119+
2. Click the "Star" button: On the repository page, you'll see a "Star" button in the upper right corner. Clicking on it will star the repository, indicating your support for the project.
147120

148121
3. Optionally, you can also leave a comment on the repository or open an issue to give feedback or suggest changes.
149122

0 commit comments

Comments
 (0)