@agilecustoms/envctl 0.23.13 → 0.23.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,13 +1,16 @@
|
|
|
1
1
|
# envctl
|
|
2
|
+
|
|
2
3
|
- npm [@agilecustoms/envctl](https://www.npmjs.com/package/@agilecustoms/envctl)
|
|
3
4
|
- npm [agilecustoms/packages](https://www.npmjs.com/settings/agilecustoms/packages) (admin view)
|
|
4
5
|
|
|
5
6
|
## usage
|
|
7
|
+
|
|
6
8
|
```shell
|
|
7
9
|
envctl deploy --env alexc -var-file=versions.tfvars -var="env=alexc" -var="log_level=debug"
|
|
8
10
|
```
|
|
9
11
|
|
|
10
12
|
## setup/update
|
|
13
|
+
|
|
11
14
|
```shell
|
|
12
15
|
npm install -g @agilecustoms/envctl # same command for update
|
|
13
16
|
envctl --version
|
|
@@ -16,19 +19,21 @@ npm view @agilecustoms/envctl version # show latest version available (without i
|
|
|
16
19
|
```
|
|
17
20
|
|
|
18
21
|
## npmjs setup
|
|
22
|
+
|
|
19
23
|
1. Login in npmjs.com
|
|
20
24
|
2. Create organization `agilecustoms` this will create scope `@agilecustoms` (one org => exactly one scope, also scope can be created w/o org)
|
|
21
|
-
3. Go to your user > Access Tokens > Generate New Token >
|
|
25
|
+
3. Go to your user > Access Tokens > Generate New Token > Granular Access Token
|
|
22
26
|
1. Token name: `agilecustoms-ci`
|
|
23
27
|
2. Packages and scopes
|
|
24
28
|
1. Permissions: Read and write
|
|
25
29
|
2. Only select packages and scopes: `@agilecustoms`
|
|
26
30
|
3. Organizations (keep as is)
|
|
27
|
-
4. Save token in
|
|
31
|
+
4. Save token in repo Settings > Environments > release > Environment secrets > Add environment secret
|
|
28
32
|
1. Name `NPMJS_TOKEN`
|
|
29
33
|
2. Repository access: `envctl` only
|
|
30
34
|
|
|
31
35
|
## History/motivation
|
|
36
|
+
|
|
32
37
|
`env-api` is a microservice hosted in 'maintenance' account and working as garbage collector: every environment first
|
|
33
38
|
created in `env-api` and then 'managed' by `env-api`: it deletes env when it is not in use anymore OR can extend lifetime.
|
|
34
39
|
Creation API yields unique ID, so you can safely manage env (delete, extend lifetime) via this ID. But creation API
|