-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a bunch of other code and doc.
- Loading branch information
Showing
56 changed files
with
3,454 additions
and
3 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# vim:ts=4:sts=4:sw=4:et | ||
# | ||
# This is the CODEOWNERS file. The syntax is as follows: | ||
# <path> <username1> [<username2> ...] | ||
|
||
# For the 'docs/' directory, @jnbdz is the code owner. | ||
/docs/ @jnbdz | ||
|
||
# For the rest of the repository, @jnbdz and @ianbenlolo are the code owners. | ||
* @jnbdz # @ianbenlolo |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
--- | ||
name: "🐛 Bug Report" | ||
description: Report a bug | ||
title: "(short issue description)" | ||
labels: [bug, needs-triage] | ||
assignees: [] | ||
body: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Describe the bug | ||
description: What is the problem? A clear and concise description of the bug. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected | ||
attributes: | ||
label: Expected Behavior | ||
description: | | ||
What did you expect to happen? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: current | ||
attributes: | ||
label: Current Behavior | ||
description: | | ||
What actually happened? | ||
Please include full errors, uncaught exceptions, stack traces, and relevant logs. | ||
If service responses are relevant, please include wire logs. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproduction | ||
attributes: | ||
label: Reproduction Steps | ||
description: | | ||
Provide a self-contained, concise snippet of code that can be used to reproduce the issue. | ||
For more complex issues provide a repo with the smallest sample that reproduces the bug. | ||
Avoid including business logic or unrelated code, it makes diagnosis more difficult. | ||
The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: solution | ||
attributes: | ||
label: Possible Solution | ||
description: | | ||
Suggest a fix/reason for the bug | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: context | ||
attributes: | ||
label: Additional Information/Context | ||
description: | | ||
Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world. | ||
validations: | ||
required: false | ||
- type: input | ||
id: version | ||
attributes: | ||
label: Version used | ||
validations: | ||
required: true | ||
- type: input | ||
id: environment | ||
attributes: | ||
label: OS name and version | ||
validations: | ||
required: true | ||
- type: input | ||
id: package-manager | ||
attributes: | ||
label: Package manager used | ||
validations: | ||
required: false | ||
- type: input | ||
id: python-version | ||
attributes: | ||
label: Python version used (if applicable) | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: 💬 General Question | ||
url: https://github.com/AmadlaOrg/amadla-cli/discussions/categories/q-a | ||
about: Please ask and answer questions as a discussion thread |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
name: "📕 Documentation Issue" | ||
description: Report an issue in the API Reference documentation or Developer Guide | ||
title: "(short issue description)" | ||
labels: [documentation, needs-triage] | ||
assignees: [] | ||
body: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Describe the issue | ||
description: A clear and concise description of the issue. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: links | ||
attributes: | ||
label: Links | ||
description: | | ||
Include links to affected documentation page(s). | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
name: 🚀 Feature Request | ||
description: Suggest an idea for this project | ||
title: "(short issue description)" | ||
labels: [feature-request, needs-triage] | ||
assignees: [] | ||
body: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Describe the feature | ||
description: A clear and concise description of the feature you are proposing. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: use-case | ||
attributes: | ||
label: Use Case | ||
description: | | ||
Why do you need this feature? For example: "I'm always frustrated when..." | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: solution | ||
attributes: | ||
label: Proposed Solution | ||
description: | | ||
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation. | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: other | ||
attributes: | ||
label: Other Information | ||
description: | | ||
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc. | ||
validations: | ||
required: false | ||
- type: checkboxes | ||
id: ack | ||
attributes: | ||
label: Acknowledgements | ||
options: | ||
- label: I may be able to implement this feature request | ||
required: false | ||
- label: This feature might incur a breaking change | ||
required: false | ||
- type: input | ||
id: version | ||
attributes: | ||
label: Version used | ||
validations: | ||
required: true | ||
- type: input | ||
id: environment | ||
attributes: | ||
label: OS name and version | ||
validations: | ||
required: false | ||
- type: input | ||
id: package-manager | ||
attributes: | ||
label: Package manager used | ||
validations: | ||
required: false | ||
- type: input | ||
id: python-version | ||
attributes: | ||
label: Python version used (if applicable) | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
name: "Source distribution issue" | ||
description: Report an issue with source distribution | ||
title: "(short issue description)" | ||
labels: [source-distribution, needs-triage] | ||
assignees: [] | ||
body: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Describe the issue | ||
description: What is the problem? A clear and concise description of the issue. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: context | ||
attributes: | ||
label: Additional Information/Context | ||
description: | | ||
All of the commands, arguments and their outputs used when trying to build the Amadla CLI. Anything else that might be relevant for troubleshooting this issue. | ||
validations: | ||
required: false | ||
- type: input | ||
id: version | ||
attributes: | ||
label: Version used | ||
validations: | ||
required: true | ||
- type: input | ||
id: environment | ||
attributes: | ||
label: OS name and version | ||
validations: | ||
required: true | ||
- type: input | ||
id: package-manager | ||
attributes: | ||
label: Package manager used | ||
validations: | ||
required: true | ||
- type: input | ||
id: python-version | ||
attributes: | ||
label: Python version used (if applicable) | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
name: Deploy with Amadla CLI | ||
|
||
on: | ||
workflow_call: | ||
secrets: | ||
GH_PAT: | ||
description: GitHub Token with permissions 'repo' and 'read:org' to list GitHub repos | ||
required: true | ||
inputs: | ||
logLevel: | ||
description: 'Log level' | ||
required: true | ||
default: 'warning' | ||
type: choice | ||
options: | ||
- info | ||
- warning | ||
- debug | ||
environment: | ||
description: 'Environment to run tests against' | ||
type: environment | ||
required: true | ||
|
||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
|
||
- name: Install Amadla CLI | ||
uses: SiteNetSoft/GitHub-Actions/.github/workflows/install-amadla-cli.yml@develop | ||
|
||
- name: Deploy | ||
uses: SiteNetSoft/GitHub-Actions/.github/workflows/deploy.yml@develop | ||
with: | ||
logLevel: ${{ github.event.inputs.logLevel }} | ||
environment: ${{ github.event.inputs.environment }} | ||
ghPat: ${{ secrets.GH_PAT }} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
name: Generate and Deploy Documentation | ||
|
||
on: | ||
release: | ||
types: [created] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name: Install Amadla CLI | ||
|
||
on: | ||
workflow_call: | ||
|
||
jobs: | ||
install-amadla-cli: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
|
||
- name: Install Amadla CLI |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
name: Update README | ||
on: | ||
push: | ||
branches: | ||
- master | ||
- main |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
name: CI/CD | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
- main | ||
pull_request: | ||
branches: | ||
- master | ||
- main |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
^3.12 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
<img src="./assets/logo-big-circle.svg" alt="Amadla logo" style="width: 450px;" align="right"> | ||
|
||
# Amadla CLI | ||
|
||
[![Language: English](https://img.shields.io/badge/Language-English-blue.svg)](./README.md) | ||
[![Language: Français](https://img.shields.io/badge/Langue-Fran%C3%A7ais-blue.svg)](./README.fr.md) | ||
|
||
[![Build Status][build_status_badge]][build_status_link] [![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/amadla.org) | ||
|
||
[![GitHub stars](https://img.shields.io/github/stars/AmadlaOrg/amadla-cli?logo=github)](https://github.com/AmadlaOrg/amadla-cli/stargazers) | ||
[![GitHub forks](https://img.shields.io/github/forks/AmadlaOrg/amadla-cli?logo=github)](https://github.com/AmadlaOrg/amadla-cli/network) | ||
[![Lines of Code](https://img.shields.io/badge/lines%20of%20code-k-lightgrey)](https://github.com/AmadlaOrg/amadla-cli#hari-sekhon---devops-bash-tools) | ||
[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/AmadlaOrg/amadla-cli/blob/master/LICENSE) | ||
[![GitHub Last Commit](https://img.shields.io/github/last-commit/AmadlaOrg/amadla-cli?logo=github)](https://github.com/AmadlaOrg/amadla-cli/commits/master) | ||
|
||
[![Python 3.11](https://img.shields.io/badge/Python-3.11+-3776AB?logo=python&logoColor=white)](https://github.com/AmadlaOrg/amadla-cli/) | ||
|
||
Cet outil, utilisant Vault, Packer, Ansible et Terraform, crée des images de serveur et construit une infrastructure. | ||
|
||
Site web: [Amadla](https://amadla.org/) | ||
|
||
## :rice_scene: Contexte | ||
|
||
La décennie précédente a connu une explosion d'outils conçus pour simplifier la configuration de serveurs cloud. Bien que cette évolution soit positive, l'assemblage et la configuration de ces outils demeurent un défi. Cette tâche est chronophage et nécessite une expertise approfondie des systèmes cloud, des outils d'Infrastructure as Code (IaC), de Linux, de la cybersécurité, etc. | ||
|
||
Pour de nombreuses personnes qui ont simplement besoin d'un environnement cloud pour exécuter des applications côté serveur simples, telles qu'un VPN, un blog, un serveur de messagerie ou un gestionnaire de fichiers, respecter les meilleures pratiques et garantir la sécurité peut sembler intimidant ; c'est trop compliqué et prend trop de temps. | ||
|
||
Amadla simplifie ce processus en automatisant la création d'un environnement cloud de base adapté à un usage personnel ou aux entreprises de toutes tailles. Il facilite également la mise en place d'un serveur et d'un environnement cloud en abstrayant de nombreux aspects. | ||
|
||
## :books: Documentation | ||
:card_index_dividers: /docs | ||
|
||
## :label: Terminologie | ||
|
||
- [IaC](https://en.wikipedia.org/wiki/Infrastructure_as_code) - Infrastructure as Code. | ||
- CE - Community Edition. | ||
- [Amadla](https://amadla.org/) - Juste un nom inventé. | ||
|
||
## :scroll: Droits d'auteur et Licence | ||
Le contenu de cette documentation est dans le domaine public. | ||
|
||
La licence pour le code se trouve dans le fichier [LICENSE](./LICENSE). | ||
|
||
--- | ||
|
||
Fabriqué au Québec :fleur_de_lis:, Canada 🇨🇦! |
Oops, something went wrong.