https://github.com/latenighttales/alcali-formula
Saltstack formula to install Alcali: a web based tool(GUI) for monitoring and administrating Saltstack Salt.
https://github.com/latenighttales/alcali-formula
gui salt saltstack saltstack-formula
Last synced: 10 days ago
JSON representation
Saltstack formula to install Alcali: a web based tool(GUI) for monitoring and administrating Saltstack Salt.
- Host: GitHub
- URL: https://github.com/latenighttales/alcali-formula
- Owner: latenighttales
- License: mit
- Created: 2019-10-05T20:31:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-03T07:20:46.000Z (over 4 years ago)
- Last Synced: 2025-01-31T07:04:16.114Z (9 months ago)
- Topics: gui, salt, saltstack, saltstack-formula
- Language: SaltStack
- Homepage: https://alcali.dev
- Size: 22.5 KB
- Stars: 15
- Watchers: 4
- Forks: 31
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# :warning: THIS FORMULA IS NO LONGER MAINTAINED. PLEASE USE https://github.com/saltstack-formulas/alcali-formula INSTEAD.
# Alcali formula
[](https://travis-ci.org/latenighttales/alcali-formula)
A SaltStack formula to install and configure [Alcali](https://github.com/latenighttales/alcali).
Alcali is a web based tool for monitoring and administrating **Saltstack** Salt.
## Available states
- [alcali](#alcali)
- [alcali.user](#alcaliuser)
- [alcali.package](#alcalipackage)
- [alcali.config](#alcaliconfig)
- [alcali.service](#alcaliservice)
- [alcali.clean](#alcaliclean)
- [alcali.user.clean](#alcaliuserclean)
- [alcali.package.clean](#alcalipackageclean)
- [alcali.config.clean](#alcaliconfigclean)
- [alcali.service.clean](#alcaliserviceclean)
## Testing
[Requirements](#requirements)
- [bin/kitchen converge](#binkitchen-converge)
- [bin/kitchen verify](#binkitchen-verify)
- [bin/kitchen destroy](#binkitchen-destroy)
- [bin/kitchen test](#binkitchen-test)
- [bin/kitchen login](#binkitchen-login)
### Alcali
_Meta-state (This is a state that includes other states)._
This create the alcali user, installs the alcali package, manages the alcali configuration file and then starts the associated alcali service.
### alcali.user
This state will create the alcali user only.
### alcali.package
This state will install the alcali package only.
### alcali.config
This state will configure the alcali service and has a dependency on alcali.install via include list.
### alcali.service
This state will start the alcali service and has a dependency on alcali.config via include list.
### alcali.clean
_Meta-state (This is a state that includes other states)._
this state will undo everything performed in the alcali meta-state in reverse order, i.e. stops the service, removes the configuration file, uninstalls the package and remove the user.
### alcali.user.clean
This state will remove the alcali user.
### alcali.service.clean
This state will stop the alcali service and disable it at boot time.
### alcali.config.clean
This state will remove the configuration of the alcali service and has a dependency on alcali.service.clean via include list.
### alcali.package.clean
This state will remove the alcali package and has a dependency on alcali.config.clean via include list.
## Testing
Linux testing is done with kitchen-salt.
### Requirements
- Ruby
- Docker
```commandline
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]
```
Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.
### bin/kitchen converge
Creates the docker instance and runs the template main state, ready for testing.
### bin/kitchen verify
Runs the inspec tests on the actual instance.
### bin/kitchen destroy
Removes the docker instance.
### bin/kitchen test
Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.
### bin/kitchen login
Gives you SSH access to the instance for manual testing.
#### TODO:
- Add multiple install options.
## Contribute
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
If you like this project, consider donating:
via GitHub Sponsors, or
[](https://ko-fi.com/J3J3173F6)
Image: Jean-Philippe WMFr, derivative work : User:Benoit Rochon [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0)