@agilecustoms/envctl 0.23.21 → 0.24.0

package/README.md

@@ -6,7 +6,9 @@
 ## usage
 
 ```shell
-envctl deploy --env alexc -var-file=versions.tfvars -var="env=alexc" -var="log_level=debug"
+terraform init -backend-config=key=laxa1986
+# TODO: remove --env in next minor release
+envctl deploy --env laxa1986 -var-file=versions.tfvars -var="log_level=debug"
 ```
 
 ## setup/update
@@ -50,7 +52,7 @@ Then as `/ci/deployer` --call--> `env-api` HTTP API (exposed with API Gateway wi
 Now the problem is: any request needs to be signed with AWS signature v4. Originally I planned to use bash scripts, but it
 quickly became bulky and hard to maintain. Then I thought about Node.js - it is available on dev machines and
 in GitHub actions (namely in Ubuntu runners). How to distribute it? First I thought about using `ncc` to bundle in one
-big .js file (as I do for `release-s3` and `gha-healthcheck`) but it will be hard to use on dev machine...
+big .js file (as I do for `publish-s3` and `gha-healthcheck`) but it will be hard to use on dev machine...
 
 So I ended up publishing this client as an npm package in npmjs
 - CI environments can install it via GH action `agilecustoms/envctl`

package/dist/commands/_keys.js

@@ -1,8 +1,7 @@
 export const _keys = {
     CWD: 'Working directory (default: current directory)',
-    ENV: 'Environment name (can be git hash). {project}-{env} give env key used to store env state (s3 key in case of AWS)',
+    ENV: 'Environment name (can be git hash). = key used to store env state (s3 key in case of AWS)',
     FORCE: 'Force deletion without confirmation',
     KIND: 'Environment kind: complete project (default) or some slice such as tt-core + tt-web',
-    OWNER: 'Environment owner (GH username)',
-    PROJECT: 'Project code (like tt). Used when multiple projects deployed in same AWS account'
+    OWNER: 'Environment owner (GH username)'
 };

package/dist/commands/createEphemeral.js

@@ -6,13 +6,12 @@ export function createEphemeral(program) {
     program
         .command('create-ephemeral')
         .description('Create bare env w/o resources. Used in CI as first step just to pre-generate token for extension')
-        .option('--project <project>', _keys.PROJECT)
         .requiredOption('--env <env>', _keys.ENV)
         .option('--owner <owner>', _keys.OWNER)
         .action(wrap(handler));
 }
 async function handler(options) {
-    const { project, env, owner } = options;
-    const token = await envCtl.createEphemeral(project, env, owner);
+    const { env, owner } = options;
+    const token = await envCtl.createEphemeral(env, owner);
     console.log(token);
 }

package/dist/commands/delete.js

@@ -6,14 +6,13 @@ export function deleteIt(program) {
     program
         .command('delete')
         .description('Delete a development environment')
-        .option('--project <project>', _keys.PROJECT)
         .option('--env <env>', _keys.ENV)
         .option('--force', _keys.FORCE)
         .option('--cwd <cwd>', _keys.CWD)
         .action(wrap(handler));
 }
 async function handler(options) {
-    const { project, env, force, cwd } = options;
+    const { env, force, cwd } = options;
     const envName = cliHelper.ensureEnv(env);
-    await envCtl.delete(project, envName, Boolean(force), cwd);
+    await envCtl.delete(envName, Boolean(force), cwd);
 }

package/dist/commands/deploy.js

@@ -6,7 +6,6 @@ export function deploy(program) {
     program
         .command('deploy')
         .description('Create new or update existing dev environment')
-        .option('--project <project>', _keys.PROJECT)
         .option('--env <env>', _keys.ENV)
         .option('--owner <owner>', _keys.OWNER)
         .option('--kind <kind>', _keys.KIND)

package/dist/commands/destroy.js

@@ -8,7 +8,6 @@ export function destroy(program) {
         .description('Destroy environment resources. This is thin wrapper for terraform destroy.'
         + ' Unlike "delete" command (which just schedule deletion) this command deletes resources synchronously.'
         + ' Main use case - test deletion process, basically that you have enough permissions to delete resources')
-        .option('--project <project>', _keys.PROJECT)
         .option('--env <env>', _keys.ENV)
         .option('--force', _keys.FORCE)
         .option('--cwd <cwd>', _keys.CWD)
@@ -17,7 +16,7 @@ export function destroy(program) {
         .action(wrap(handler));
 }
 async function handler(tfArgs, options) {
-    const { project, env, force, cwd } = options;
+    const { env, force, cwd } = options;
     const envName = cliHelper.ensureEnv(env);
-    await envCtl.destroy(project, envName, tfArgs, Boolean(force), cwd);
+    await envCtl.destroy(envName, tfArgs, Boolean(force), cwd);
 }

package/dist/commands/init.js

@@ -6,13 +6,12 @@ export function init(program) {
     program
         .command('init')
         .description('Terraform init wrapper')
-        .option('--project <project>', _keys.PROJECT)
         .option('--env <env>', _keys.ENV)
         .option('--cwd <cwd>', _keys.CWD)
         .action(wrap(handler));
 }
 async function handler(options) {
-    const { project, env, cwd } = options;
+    const { env, cwd } = options;
     const envName = cliHelper.ensureEnv(env);
-    await envCtl.init(project, envName, cwd);
+    await envCtl.init(envName, cwd);
 }

package/dist/commands/plan.js

@@ -7,7 +7,6 @@ export function plan(program) {
         .command('plan')
         .description('High level wrapper for terraform plan. Compliments deploy command: if you plan to deploy env with envctl deploy,'
         + ' then it is recommended to do plan with envctl plan to guarantee consistent behavior')
-        .option('--project <project>', _keys.PROJECT)
         .option('--env <env>', _keys.ENV)
         .option('--owner <owner>', _keys.OWNER)
         .option('--cwd <cwd>', _keys.CWD)

package/dist/commands/status.js

@@ -6,13 +6,12 @@ export function status(program) {
     program
         .command('status')
         .description('Get env status')
-        .option('--project <project>', _keys.PROJECT)
         .option('--env <env>', _keys.ENV)
         .option('--cwd <cwd>', _keys.CWD)
         .action(wrap(handler));
 }
 async function handler(options) {
-    const { project, env, cwd } = options;
+    const { env, cwd } = options;
     const envName = cliHelper.ensureEnv(env);
-    await envCtl.status(project, envName, cwd);
+    await envCtl.status(envName, cwd);
 }

package/dist/service/EnvCtl.js

@@ -9,11 +9,11 @@ export class EnvCtl {
         this.envApi = envApi;
         this.terraformAdapter = terraformAdapter;
     }
-    key(project, env) {
-        return project ? `${project}-${env}` : env;
+    key(env) {
+        return env;
     }
-    async status(project, envName, cwd) {
-        const key = this.key(project, envName);
+    async status(envName, cwd) {
+        const key = this.key(envName);
         console.log(`Retrieve env ${key}`);
         const env = await this.envApi.get(key);
         if (env === null) {
@@ -34,7 +34,7 @@ export class EnvCtl {
             console.log(`Env name not provided, default to owner name ${owner}`);
             envName = owner;
         }
-        const key = this.key(input.project, envName);
+        const key = this.key(envName);
         console.log(`Check if env ${key} already exists`);
         const env = await this.envApi.get(key);
         if (env) {
@@ -63,8 +63,8 @@ export class EnvCtl {
         }
         throw new KnownException(`Env ${env.key} status is ${env.status}, can not run this command`);
     }
-    async init(project, envName, cwd) {
-        const key = this.key(project, envName);
+    async init(envName, cwd) {
+        const key = this.key(envName);
         await this.terraformAdapter.init(key, cwd, true);
     }
     async plan(input, tfArgs, cwd) {
@@ -88,8 +88,8 @@ export class EnvCtl {
         await this.terraformAdapter.init(key, cwd);
         await this.terraformAdapter.plan(envTerraform, cwd);
     }
-    async createEphemeral(project, envName, owner) {
-        const key = this.key(project, envName);
+    async createEphemeral(envName, owner) {
+        const key = this.key(envName);
         const env = await this.envApi.get(key);
         if (env !== null) {
             throw new KnownException(`Env ${key} already exists`);
@@ -146,8 +146,8 @@ export class EnvCtl {
         console.log('Activating env (to finish creation)');
         await this.envApi.activate(env);
     }
-    async delete(project, envName, force, cwd) {
-        const env = await this.get(project, envName);
+    async delete(envName, force, cwd) {
+        const env = await this.get(envName);
         if (!force) {
             this.checkStatus(env);
             if (env.status === EnvStatus.Init) {
@@ -174,8 +174,8 @@ export class EnvCtl {
         const message = await this.envApi.delete(env);
         console.log(message);
     }
-    async destroy(project, envName, tfArgs, force, cwd) {
-        const env = await this.get(project, envName);
+    async destroy(envName, tfArgs, force, cwd) {
+        const env = await this.get(envName);
         this.checkStatus(env);
         if (env.status === EnvStatus.Init) {
             console.log(`Env ${env.key} has no resources, nothing to destroy, call 'delete' command instead`);
@@ -206,8 +206,8 @@ export class EnvCtl {
         await this.envApi.delete(env);
         console.log('Please wait for ~15 sec before you can create env with same name');
     }
-    async get(project, envName) {
-        const key = this.key(project, envName);
+    async get(envName) {
+        const key = this.key(envName);
         console.log(`Retrieve env ${key}`);
         const env = await this.envApi.get(key);
         if (!env) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@agilecustoms/envctl",
   "description": "node.js CLI client for manage environments",
-  "version": "0.23.21",
+  "version": "0.24.0",
   "author": "Alex Chekulaev",
   "type": "module",
   "bin": {