MG-153 - Add Vault scripts as git subtree #157
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
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 |
|---|---|---|
| @@ -1,170 +1,17 @@ | ||
| # Running Vault Setup Scripts with `--env-file` | ||
|
|
||
| To execute a Vault setup script, use the `--env-file` option to provide the path to your `.env` file. Here's the general syntax: | ||
|
|
||
| ```bash | ||
| ./<script-name>.sh --env-file <path-to-your-env-file> | ||
| ``` | ||
|
|
||
| ### Example | ||
|
|
||
| To initialize Vault using the provided setup script, run: | ||
|
|
||
| ```bash | ||
| scripts/vault/scripts/vault_init.sh --env-file scripts/vault/.env | ||
| ``` | ||
|
|
||
| For detailed documentation on the available scripts and their usage, visit the [Vault Addon Documentation](https://github.com/absmach/magistrala/tree/main/docker/addons/vault#readme). | ||
|
There was a problem hiding this comment. Please add following guide# Developer Guide: Updating Vault Scripts from Magistrala
This guide provides step-by-step instructions to update the Vault scripts in your local Magistrala DevOps repository, sync them with the `main` branch of the Magistrala repository, and create a pull request (PR) to merge the changes.
## Prerequisites
Make sure you have the following:
- A local clone of the Magistrala DevOps repository.
- Access to the Magistrala GitHub repository (`https://github.com/absmach/magistrala.git`).
## Step 1: Create new branch
Create a new branch from `master` brach
```bash
git checkout -b <your-branch-name>
``
Replace `<your-branch-name>` with the name a new branch name.
## Step 2: Add the Magistrala Remote
If the Magistrala remote is not already added to your local repository, use the following command to add it:
```bash
git remote add -f magistrala https://github.com/absmach/magistrala.git
``
## Step 3: Add Subtree for Vault Scripts
If the subtree for the Vault scripts has not been added, execute the following command:
```bash
git subtree add --prefix=scripts/vault/scripts magistrala main --squash --prefix=docker/addons/vault/scripts
``
- `--prefix=scripts/vault/scripts`: Specifies the target directory in your local repository where the Vault scripts will be added.
- `magistrala main`: Refers to the `main` branch of the Magistrala repository.
- `--squash`: Combines all commits from the Magistrala `main` branch into a single commit when adding the subtree.
## Step 4: Update Vault Scripts to the Latest Version
To update the Vault scripts to the latest version and synchronize with the `main` branch of the Magistrala repository, use the following command:
```bash
git subtree pull --prefix=scripts/vault/scripts magistrala main --squash --prefix=docker/addons/vault/scripts
``
- This command pulls the latest changes from the `main` branch of the Magistrala repository.
- `--squash` creates a single commit for the changes, making the history simpler to manage.
## Step 5: Push Changes and Create a Pull Request
After syncing with the Magistrala `main` branch, push the changes to your working branch:
```bash
git push origin <your-branch-name>
``
Replace `<your-branch-name>` with the name of the branch you're working on.
Once the changes are pushed, go to your GitHub repository and create a pull request (PR) to merge the updates.
## Summary of Commands related to Git subtree
### Add Magistrala Remote
```bash
git remote add -f magistrala https://github.com/absmach/magistrala.git
``
### Add Subtree for Vault Scripts
```bash
git subtree add --prefix=scripts/vault/scripts magistrala main --squash --prefix=docker/addons/vault/scripts
``
### Update Vault Scripts to the Latest
```bash
git subtree pull --prefix=scripts/vault/scripts magistrala main --squash --prefix=docker/addons/vault/scripts
`` |
||
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 |
|---|---|---|
|
|
@@ -3,4 +3,3 @@ | |
|
|
||
| data | ||
| magistrala_things_certs_issue.hcl | ||
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,24 @@ | ||
| #!/usr/bin/bash | ||
| # Copyright (c) Abstract Machines | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| vault() { | ||
| if is_container_running "magistrala-vault"; then | ||
| docker exec -it magistrala-vault vault "$@" | ||
| else | ||
| if which vault &> /dev/null; then | ||
| $(which vault) "$@" | ||
| else | ||
| echo "magistrala-vault container or vault command not found. Please refer to the documentation: https://github.com/absmach/magistrala/blob/main/docker/addons/vault/README.md" | ||
| fi | ||
| fi | ||
| } | ||
|
|
||
| is_container_running() { | ||
| local container_name="$1" | ||
| if [ "$(docker inspect --format '{{.State.Running}}' "$container_name" 2>/dev/null)" = "true" ]; then | ||
| return 0 | ||
| else | ||
| return 1 | ||
| fi | ||
| } |
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,86 @@ | ||
| #!/usr/bin/bash | ||
| # Copyright (c) Abstract Machines | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| scriptdir="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)" | ||
|
|
||
| # default env file path | ||
| env_file="docker/.env" | ||
|
|
||
| # default certs copy path | ||
| certs_copy_path="docker/ssl/certs/" | ||
|
|
||
| while [[ "$#" -gt 0 ]]; do | ||
| case $1 in | ||
| --env-file) | ||
| if [[ -z "${2:-}" ]]; then | ||
| echo "Error: --env-file requires a non-empty option argument." | ||
| exit 1 | ||
| fi | ||
| env_file="$2" | ||
| if [[ ! -f "$env_file" ]]; then | ||
| echo "Error: .env file not found at $env_file" | ||
| exit 1 | ||
| fi | ||
| shift | ||
| ;; | ||
| --certs-copy-path) | ||
| if [[ -z "${2:-}" ]]; then | ||
| echo "Error: --certs-copy-path requires a non-empty option argument." | ||
| exit 1 | ||
| fi | ||
| certs_copy_path="$2" | ||
| shift | ||
| ;; | ||
| *) | ||
| echo "Error: Unknown parameter passed: $1" | ||
| exit 1 | ||
| ;; | ||
| esac | ||
| shift | ||
| done | ||
|
|
||
| readDotEnv() { | ||
| set -o allexport | ||
| source "$env_file" | ||
| set +o allexport | ||
| } | ||
|
|
||
| readDotEnv | ||
|
|
||
| server_name="localhost" | ||
|
|
||
| # Check if MG_NGINX_SERVER_NAME is set or not empty | ||
| if [ -n "${MG_NGINX_SERVER_NAME:-}" ]; then | ||
| server_name="$MG_NGINX_SERVER_NAME" | ||
| fi | ||
|
|
||
| echo "Copying certificate files to ${certs_copy_path}" | ||
|
|
||
| if [ -e "$scriptdir/data/${server_name}.crt" ]; then | ||
| cp -v "$scriptdir/data/${server_name}.crt" "${certs_copy_path}magistrala-server.crt" | ||
| else | ||
| echo "${server_name}.crt file not available" | ||
| fi | ||
|
|
||
| if [ -e "$scriptdir/data/${server_name}.key" ]; then | ||
| cp -v "$scriptdir/data/${server_name}.key" "${certs_copy_path}magistrala-server.key" | ||
| else | ||
| echo "${server_name}.key file not available" | ||
| fi | ||
|
|
||
| if [ -e "$scriptdir/data/${MG_VAULT_PKI_INT_FILE_NAME}.key" ]; then | ||
| cp -v "$scriptdir/data/${MG_VAULT_PKI_INT_FILE_NAME}.key" "${certs_copy_path}ca.key" | ||
| else | ||
| echo "$scriptdir/data/${MG_VAULT_PKI_INT_FILE_NAME}.key file not available" | ||
| fi | ||
|
|
||
| if [ -e "$scriptdir/data/${MG_VAULT_PKI_INT_FILE_NAME}_bundle.crt" ]; then | ||
| cp -v "$scriptdir/data/${MG_VAULT_PKI_INT_FILE_NAME}_bundle.crt" "${certs_copy_path}ca.crt" | ||
| else | ||
| echo "$scriptdir/data/${MG_VAULT_PKI_INT_FILE_NAME}_bundle.crt file not available" | ||
| fi | ||
|
|
||
| exit 0 |
Oops, something went wrong.
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.
@JeffMboya This part is moved
scripts/vault/Readme.md, so i think it is no more needed hereWhat do you think ?
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.
Yes, it should be removed.