Skip to content

Commit db224ad

Browse files
cnusscnuss
committed
License + README
1 parent 0f7e3a4 commit db224ad

23 files changed

Lines changed: 501 additions & 124 deletions

‎LICENSE‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎README.md‎

Lines changed: 70 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,106 @@
1-
# Terraform Remote State Management using a GitHub Token
1+
# Terraform State Storage Backend for GitHub Tokens
22

3-
[Scaffoldly](https://scaffold.ly) provides [a Remote State API](https://api.tfstate.dev/github/swagger.html)
4-
for secure [Terraform Remote State](https://www.terraform.io/language/settings/backends/http)
5-
hosting using a GitHub Token.
3+
This is a REST API for storing Terraform State using a Terraform HTTP State.
64

7-
Features:
5+
Authentication and authorization is done using a GitHub token.
86

9-
- Zero Bootstrapping: if you have a GitHub token, you can use this API
10-
- [Hosted API](https://api.tfstate.dev/github/swagger.html) in AWS Lambda + API
11-
Gateway in AWS courtsey of [Scaffoldly](https://scaffold.ly)
12-
- [Encrypted State](src/services/StateService.ts#L27)
13-
- State Locking
7+
## Using this API
148

15-
✅ We do not store or save the provided GitHub token.
9+
This API is publicly hosted at:
1610

17-
## Usage
11+
https://api.tfstate.dev/github/swagger.html
1812

19-
### 1. Create a `tfstate.tfbackend` file with a GitHub Token with `repo` or `repo:read` access to the Repository specified by `username`:
13+
To use it in Terraform, please see the documentation here:
2014

21-
```hcl
22-
username = "my-org/my-repo"
23-
password = "ghp_abcd..."
24-
```
15+
[TFstate.dev Homepage](https://tfstate.dev)
16+
17+
## Developing/Contributing to this API
18+
19+
We'd love contributions from the community to improve this API.
20+
21+
### Running
22+
23+
Requirements:
24+
25+
- NodeJS 14+
26+
- Yarn
27+
28+
Running instructions:
29+
30+
1. Fork and clone this repo
31+
1. Run `yarn`
32+
1. Run `yarn start` (launches Serverless in Local mode)
33+
34+
The main controller is [`ControllerV1`](src/controllers/ControllerV1.ts). It contains the primary endpoints for State Storage.
35+
36+
Once running locally, the OpenAPI docs can be found at:
2537

26-
_Note_: Be sure to exclude `tfstate.tfbackend` from source control in the `.gitignore`.
38+
https://localhost:3000/github/swagger.html
2739

28-
_Note_: This can be a Personal Access Token or a token generated by GitHub OAuth
40+
### Verifying Locally
2941

30-
### 2. Configure Terraform for Remote State
42+
While running the API locally, create a basic Terraform structure to test state functions:
3143

3244
```hcl
3345
terraform {
3446
backend "http" {
35-
address = "https://api.tfstate.dev/github/v1"
36-
lock_address = "https://api.tfstate.dev/github/v1/lock"
37-
unlock_address = "https://api.tfstate.dev/github/v1/lock"
47+
address = "http://localhost:3000/github/v1"
48+
lock_address = "http://localhost:3000/github/v1/lock"
49+
unlock_address = "http://localhost:3000/github/v1/lock"
3850
lock_method = "PUT"
3951
unlock_method = "DELETE"
52+
53+
# Make sure this is a real repository that your token has access to
54+
username = "{your-github-user}/github-sls-rest-api"
4055
}
4156
}
57+
58+
resource "null_resource" "example" {
59+
60+
}
61+
62+
output "null_resource_id" {
63+
value = null_resource.example.id
64+
}
4265
```
4366

44-
### 3. Initialize Terraform
67+
Then, run:
4568

4669
```bash
47-
terraform init -backend-config=tfstate.tfbackend -reconfigure [-migrate-state]
70+
export TF_HTTP_PASSWORD={your-github-token}
71+
terraform init
72+
terraform plan
73+
terraform apply
4874
```
4975

50-
_Note_: If you have a token that rotates regularly (such as Server-to-Server) tokens
51-
generated by a GitHub Application, you will need to run `-reconfigure` each time
52-
the token rotates.
76+
Other command to verify with:
5377

54-
See the [Terraform Docs](https://www.terraform.io/cli/commands/init#backend-initialization)
55-
for specifics on migrating existing state.
78+
```bash
79+
terraform state ...
80+
terraform force-unlock ...
81+
```
5682

57-
# Questions/Comments/Issues?
83+
## Contributing Guidelines
5884

59-
Please create a [new issue](https://github.com/tfstate/github-sls-rest-api/issues/new/choose)
60-
on GitHub.
85+
See [CONTRIBUTING](./CONTRIBUTING.md)
6186

62-
# Maintainers
87+
## Maintainers
6388

6489
- [cnuss](https://github.com/cnuss)
6590
- [Scaffoldly](https://github.com/scaffoldly)
6691

67-
# About Scaffoldly and `tfstate.dev`
68-
69-
[Scaffoldly](https://scaffold.ly) provides various services and automations to
70-
simplify Infrastructure Bootstrapping and DevOps.
71-
72-
`tfstate.dev` is provided as a free and easy way to store Terraform State. We've
73-
open sourced it for transparency to show how it handles and secures Terraform state.
74-
75-
We were inspired by [GitLab's ability](https://docs.gitlab.com/ee/user/infrastructure/iac/terraform_state.html)
76-
to host Terraform State, and wanted the same functionality for GitHub.
92+
## License
7793

78-
Scaffoldly is not affiliated with GitHub.
94+
Copyright 2022 Scaffoldly LLC
7995

80-
## Want to host `github-sls-rest-api` in your own AWS Account?
96+
Licensed under the Apache License, Version 2.0 (the "License");
97+
you may not use this file except in compliance with the License.
98+
You may obtain a copy of the License at
8199

82-
Scaffoldly can help!
100+
http://www.apache.org/licenses/LICENSE-2.0
83101

84-
[Message us on Gitter](https://gitter.im/scaffoldly/community) for details.
102+
Unless required by applicable law or agreed to in writing, software
103+
distributed under the License is distributed on an "AS IS" BASIS,
104+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
105+
See the License for the specific language governing permissions and
106+
limitations under the License.

‎src/app.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
/**
2+
Copyright 2022 Scaffoldly LLC
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
116
import {
217
corsHandler,
318
CorsOptions,

‎src/auth.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
/**
2+
Copyright 2022 Scaffoldly LLC
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
116
import { authorize } from '@scaffoldly/serverless-util';
217
import { env } from './env';
318

‎src/controllers/ControllerV1.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
/**
2+
Copyright 2022 Scaffoldly LLC
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
116
import { HttpRequest } from '@scaffoldly/serverless-util';
217
import {
318
Body,

0 commit comments

Comments
 (0)