-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: add sami-cli specs #2
Open
elhmn
wants to merge
2
commits into
main
Choose a base branch
from
add-the-sami-cli-specs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
File renamed without changes.
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,100 @@ | ||
# Sami-cli specs | ||
|
||
The **sami-cli** is a tool that allows us to deploy our applications on any infrastructure, | ||
whether it's on [swarm](https://docs.docker.com/engine/swarm/) or [k8s](https://kubernetes.io/). | ||
|
||
## How it works ? | ||
Each application deployed by the **sami-cli** should follow a certain structure. | ||
The application deployments live in a folder that contains its deployment manifests | ||
and a `sami.yaml` that gathers all the information and metadata required to deploy | ||
the application. | ||
|
||
### The folder structure | ||
|
||
An application folder will live in a [deployments](https://github.com/osscameroon/deployments) repository. | ||
The folder should be named after the application you want to deploy and stored in the `services` folder. | ||
as it is done for the [camerdevs](https://github.com/osscameroon/deployments/tree/main/services) application. | ||
|
||
Under this `deployments/services/<application_name>` folder should be added a folder named | ||
after the type of deployment you want to perform. The deployment can be either `compose` or `k8s` deployment. | ||
|
||
In the `deployments/services/<application_name>/<deployment_type>` should be added your | ||
application deployment manifests along with a `sami.yaml` file. | ||
|
||
An example of deployment manifests can be found [here](https://github.com/osscameroon/deployments/tree/main/services/camerdevs/compose/stage). | ||
|
||
|
||
### The `sami.yaml` file | ||
|
||
The `sami.yaml` file contains your application metadata along with informations required | ||
to deploy your applications. | ||
|
||
| Fields | Description | | ||
|--------------|-----------------------| | ||
|`version` | The version of the `sami.yaml` file it is set using semantic versionning `v0`| | ||
|`service_name` | The name of the service you want to deploy. **Example: camerdevs** | ||
|`type` | The type of deployment you want to use can be `swarm|k8s|cron` | ||
|`pr_deploy` | Set wheter it is a pull request deployment or not. set to `false` by default | ||
|`files` | Is a list of deployment files. for camerdevs it should be set to `- camerdevs-stack.yml` | ||
|`oob` | The out of band field indicate which field and file should be edited when a deployment is performed, we could change the image sha of `service.api.image` field in the `camerdevs-stack.yml` file | ||
|`oob.[].key.path` | Path to the field we want to edit in the deployment file | ||
|`oob.[].key.file` | name of the file to the field we want to edit in the deployment file | ||
Comment on lines
+34
to
+41
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it possible to add :
|
||
|
||
### `sami-cli` commands | ||
|
||
The `sami-cli` has several commands that help us deploy, monitor and apply changes to our deployment. | ||
|
||
|
||
#### `sami deploy` | ||
|
||
This command takes a `sami.yaml` file and apply your deployment manifest to deploy the application in your infrastructure | ||
|
||
``` | ||
sami deploy -f deployments/services/camerdevs/compose/sami.yaml | ||
``` | ||
|
||
*NOTE: If the file is not provided to the command, sami will look for a file in the current directory.* | ||
|
||
#### `sami logs` | ||
|
||
Displays logs of a given service | ||
|
||
``` | ||
sami logs | ||
``` | ||
|
||
OR | ||
|
||
To watch the service logs as they appear | ||
|
||
``` | ||
sami logs --watch | ||
``` | ||
|
||
|
||
#### `sami oob` | ||
|
||
The `oob` (out of bands) command is used to change the value of a specific field in our deployment files. | ||
|
||
For a given `sami.yaml`, running `sami oob update-image "new-image"` will update the `stack.yaml` file | ||
on this `.services.frontend.image` to `new-image`. | ||
|
||
```yaml | ||
version: v1beta | ||
|
||
service_name: "camerdevs" | ||
type: "swarm" | ||
files: | ||
- ./stack.yaml | ||
oob: | ||
- update-image: | ||
file: "./stack.yaml" | ||
path: ".services.frontend.image" | ||
``` | ||
|
||
|
||
#### `sami status` | ||
|
||
Shows the status of a given service | ||
|
||
`sami status -f ./sami.yaml` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How the version can impact the implementation of the CLI ? 🤔