Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tty47/axectl
DevOps/SRE set of tools
https://github.com/tty47/axectl
devops go golang infrastructure infrastructure-as-code infrastructure-management sre tooling tools
Last synced: about 15 hours ago
JSON representation
DevOps/SRE set of tools
- Host: GitHub
- URL: https://github.com/tty47/axectl
- Owner: tty47
- License: apache-2.0
- Created: 2021-12-04T21:39:31.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-24T07:46:43.000Z (almost 2 years ago)
- Last Synced: 2024-12-26T04:34:09.507Z (about 2 months ago)
- Topics: devops, go, golang, infrastructure, infrastructure-as-code, infrastructure-management, sre, tooling, tools
- Language: Go
- Homepage: https://github.com/jrmanes/axectl
- Size: 35 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# axectl
```bash
+--------------------------------------------------+
| |
| .dx:. |
| cO00Ok; |
| .x00OOOkkx. |
| .d00OOOkkkxl |
| :kOOOOkkkxl;' |
| .l00OOOkkkxd:;cc' |
| 'd00OOOOkkkdc',:lol, |
| ,d000OOOkkkxd,..',:loo: |
|.d000OOOkkkxxxl ..,:codl. |
|xO0OOOkkkxxxxd, .;cldo; |
|:kkOOkkkxxxddo. ':codl' |
| ;xxkkxxxdddd: .,:lddl. |
| .cxddddddoo. .;codd; |
| .:ddooooc ':lddl' |
| .,clo, .,coddc. |
| .:lddo,. |
| ,clddl, |
| .;lodo:. |
| ,clddl, |
| .;codoc. |
| ':lddo:. |
| .;codoc, |
| .,:lool:.|
| .;cloo:|
| .,:c;.|
| |
| |
+--------------------------------------------------+
```
---
# Index
1. [Description](#description)
2. [Build project](#build_project)
3. [Sonar](#paragraph2)
1. [What it does?](#whatitdoes)
4. [Examples](#examples)
5. [Sconar Scanner](#sonar-scanner)
6. [Add to path](#addtopath)
7. [TODO](#todo)
---
## This is the introduction
Some introduction text, formatted in heading 2 style
## Some paragraph
The first paragraph text
`axectl` is a set of DevOps/SRE tools for developers, we can create different commands to abstract manual tasks.
This tool is written in [Go](https://go.dev/) with the [cobra](https://github.com/spf13/cobra) framework.
As result of the project, we obtain a binary which can be compiled for the different platforms and architectures.
---
To build the project from your side, you need `Go` installed in your computer, and execute:
Remember to check your `OS` and your architecture.
```
mkdir -p ./bin
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o ./bin/axectl ./
```
Or you can go to the releases page.
---
axectl has the command `sonar` which allows you to setup and configure a **SonarQube** in your local dev env.
This command is an abstraction to setup and configure the project in **SonarQube**.
The CLI with the command `sonar` uses [docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/) to create the resources needed.
Some [features](#features) are:
- Use three docker containers:`SonarQube`, `PostgreSQL` and `sonar-scanner`.
- `SonarQube` -> server
- `PostgreSQL` -> database engine
- `sonar-scanner` -> tool from Sonar to analyse the code
- The tool `axectl` communicates to the `SonarQube` API to create the projects and the tokens automatically, the tokens are store in the path `~/.axectl/sonar/token`
- `axectl` has the flag `-i` which install the needed requirements for you, the requirements are:
- docker
- docker-compose
- The flag `-i` also add your user to the `Docker` group.
- It asks you to restart your computer for changes to take effect.
- Install requirements, this step install all the requirements to run `Docker` and the `sonar-scanner` in your computer. [features](#features)
- After the installation, you will be prompt to restart your computer, this is because is needed after add your user to the `Docker` group [source](https://docs.docker.com/engine/install/linux-postinstall/)
```bash
axectl sonar -i
```
- Start the service, creating the projects and scan them
```bash
axectl sonar -s -c --scan -p "someProject" -o "someOrganization"
```
- Start the service
```bash
axectl sonar -s -p "someProject" -o "someOrganization"
```
- Start the service creating the projects
```bash
axectl sonar -s -c -p "someProject" -o "someOrganization"
```
- Check the status of the service
```bash
axectl sonar --status
```
- Start the SonarQube service
```bash
axectl sonar -s
```
---
You can execute the following command in order to run the analysis directly.
```bash
docker run \
--rm \
--network=host \
-e SONAR_HOST_URL="http://sonarqube:9000" \
-v $PWD:/usr/src sonarsource/sonar-scanner-cli \
-Dsonar.projectKey=axectl \
-Dsonar.sonar.projectName=axectl \
-Dsonar.sonar.projectVersion=1.0 \
-Dsonar.scm.disabled=true \
-Dsonar.sources=./ \
-Dsonar.sonar.host.url=http://sonarqube:9000 \
-Dsonar.login=`+token
```
---
You can easily execute `axectl` anywhere adding the binary to some path that you have configured in your `$PATH`.
You can use for instance the path:
`/usr/bin/`
Execute the command:
```bash
sudo cp ./axectl /usr/bin/
```
---
## TODO
- [x] Install dependencies
- [x] Start all the containers
- [x] Check containers status
- [x] Generate project in Sonar
- [x] Generate token for project
- [x] Create config path
- [x] Create tokens inside the config path
- [x] List tokens
- [ ] Delete tokens
- [ ] Delete all resources created
- [x] Setup debug argument
- [x] Update release from the CLI
- [x] Remove installation packages for `sonar-scanner`
- [x] Refactor
- [ ] Flag to specify the code coverage file
---
Jose Ramon Mañes