@codemaskinc/argo-composer
v0.3.1
Published
An configurable, templated and structured interactive command-line interface for initializing, creating and maintaining your ArgoCD resources repository.
Downloads
5
Keywords
Readme
Argo Composer
An configurable, templated and structured interactive command-line interface for initializing, creating and maintaining your ArgoCD resources repository.
Features
- Apps-of-Apps pattern out-of-the-box
- Set of ready-to-use templates for Applications
- Easy to use interractive commands for creating, copying and removing Argo Application manifests
Installation
using npm
:
$ npm install -g @codemaskinc/argo-composer
or, using yarn
:
$ yarn global add @codemaskinc/argo-composer
Initializing your argocd resources repository
After successful installation, we can now proceed to initialize the argocd-resources
repository by calling the following command:
$ argo-composer init-project
The argo composer will take you through the interractive process of asking few questions on how you want your project to look like.
1. What name would you like to use for the project?
[!TIP] The
name of the project
is simply a directory name where theargo composer
will initialize to. Also, leaving this option empty will initialize the project in thecurrent working directory
.
2. What is the base URL of GitHub repository?
[!TIP] The GitHub repository is then saved in root configuration, to be used as a default value when creating your Application.
3. What will be the environment inside your cluster?
[!TIP] The current default environment configuration is
dev
andprod
, used for creating your Application overlays. Choose the environment to your project needs, for example it could be:integration
,staging
,production
.
4. Do you want to install any additional components?
[!TIP] Select needed components (aka addons) to your project - by default it is
infra
- creating an example applications for each selected component and installs via Helm.
5. What name would you like to use for addons?
[!TIP] Configurable to your liking, choose a project name for example
common
(by defaultinfra
).
Commands
To begin working with argo-composer
command line, we recommend to use a help command first, by calling:
$ argo-composer --help
Adding project
To add a another argocd project
, use:
$ argo-composer add-project
Removing project
To remove project, use:
$ argo-composer remove-project
Adding application to a project
To add a another argocd application
to a existing project, use:
$ argo-composer add-app
Removing application for a project
To remove application, use:
$ argo-composer remove-app
Copying existing application to a project
To copy application, use:
$ argo-composer copy-app
Development
[!IMPORTANT] We are currently in development of project Argo Composer. If you are made this far - yay! - and maybe would like to contribute to this project? Then you are more than welcome to visit the provided link to a guide below :pray:!