adctl

README

ADCTL

English | 中文

Overview

auto deploy ctl similar as helm, Adctl is a tool for managing Charts,Charts are package of pre-configured docker-compose yaml resource

To Use Adctl:

• auto deploy docker applications via docker-compose
• share your own applications as Adctl Charts
• Manage releases of Adctl packages

Install

adctl is a command line program to deploy applications via docker-compose.

It can be installed by running:

go install github.com/shikingram/adctl@latest

Example

Precondition

docker and docker-compose are required for this tool,The minimum required version is

$docker --version 
Docker version 20.10.11, build dea9396

$docker-compose --version  
docker-compose version 1.29.2, build 5becea4c

clone adctl to local:

git clone https://github.com/shikingram/adctl.git

install:

adctl install -f adctl/examples/my-values.yaml example adctl/examples

uninstall:

adctl uninstall example --clean-instance

Usage

adctl nstall

This command can render all yaml files of an application, and then deploy it to docker

eg:

adctl install name chart

The chart package should have the following structure:

example-chart
├── Chart.yaml
├── templates
│   ├── 01-app-mysql.yaml.gtpl
│   ├── NOTES.txt
│   └── config
│       └── mysql
│           └── config.gtpl
└── values.yaml

After executing adctl install, we will generate an instance in the current directory and start it in docker vi docker-compose

adctl upgrade

This command upgrades a release to a new version of a chart

When we modify some configurations, we can execute this command for up-to-date

adctl uninstall

This command takes a release name and uninstalls the release.

However, in order to protect data from being lost, the locally generated directory instancewill not be deleted. If you really need to delete it, you can use flag --clean-instance

More Informations

for more informations, try to use adctl --help to view details

Documentation

Overview

Copyright © 2022 Kingram <kingram@163.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.