Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nutgaard/dktp
A simple cli to interact with Azure ContainerApps with arm/yaml templates
https://github.com/nutgaard/dktp
Last synced: about 2 months ago
JSON representation
A simple cli to interact with Azure ContainerApps with arm/yaml templates
- Host: GitHub
- URL: https://github.com/nutgaard/dktp
- Owner: nutgaard
- Created: 2024-05-20T18:27:43.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-11-14T08:11:55.000Z (about 2 months ago)
- Last Synced: 2024-11-14T09:21:11.877Z (about 2 months ago)
- Language: TypeScript
- Size: 313 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# dktp
A simple cli to interact with Azure ContainerApps with arm/yaml templates
## Usage
```shell
Usage: dktp [options] [command]
CLI to help working dktp apps
Options:
-h, --help display help for command
Commands:
wrap [options] [outputfile] Download secrets, and encrypt environment
run [options] Run command with environment variables from lock-file
inspect [options] Print content of encrypted lock-file
help [command] display help for command
```
### Wrap: Download and encrypt environment
```shell
Usage: dktp wrap [options] [outputfile]
Download secrets, and encrypt environment
Arguments:
configfile Path to dktp yaml file
outputfile Path to encrypted vault file
Options:
-c, --container Container name to process (defaults to create a combined env file)
-e, --env Envfile to use for interpolation
-h, --help display help for command
Example: dktp wrap example/main.yml -e example/prod.env example/prod.env.locked
```
### Run: Start a process with environment variable set
```shell
Usage: dktp run [options]
Run command with environment variables from lock-file
Arguments:
env_file Envfile to use for process
command The command to run
Options:
-o, --override [keyvalue...] Override or pass extra environment variable, e.g MY_VAR=abba (default: {})
-h, --help display help for command
Example: dktp run example/prod.env.locked -o APP_NAME=Hello -- node index.mjs
```
### Inspect: Print the content of a encrypted lock-file
```shell
Usage: dktp inspect [options]
Print content of encrypted lock-file
Arguments:
env_file File to inspect
Options:
-o, --override [keyvalue...] Override or pass extra environment variable, e.g MY_VAR=abba (default: {})
-h, --help display help for command
Example: dktp inspect example/prod.env.locked -o APP_NAME=Hello
```
## Contribution
To install dependencies:
```bash
bun install
```
To run:
```bash
bun run src/index.ts
```
To test wrapping of secrets;
1. Update [targetPlatform.ts](src/utils/targetPlatform.ts) to set `AZ_MOCK = true`.
2. Run `bun run src/index.ts wrap example/main.yml -e example/prod.env example/prod.env.locked`
### Commiting changes
This repository uses commitizen and conventional-changelog to determine which new semver-version should be used in a release.
To help with keeping your commits correctly formatted please use `bun commit` / `npm run commit`.