Improve the configuration path name.guide

tungbq · Aug 17, 2024 · 8deef3b · 8deef3b
1 parent 4a4e72e
commit 8deef3b
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 16 deletions.
diff --git a/docs/usage/ansible_usage.md b/docs/usage/ansible_usage.md
@@ -22,7 +22,7 @@ For instructions on common run modes, visit [**DevOps Toolkit Common Run Mode**]
 ## Use case 1: Run Ansible sample code provided in the container
 
 ```bash
-docker run --rm --network host -v ~/.dtc:/config -it tungbq/devops-toolkit:latest
+docker run --rm --network host -v ~/.dtc:/dtc -it tungbq/devops-toolkit:latest
 
 # You now in the container terminal
 ansible-playbook samples/ansible/check_os.yml
@@ -31,7 +31,7 @@ ansible-playbook samples/ansible/check_os.yml
 ## Use case 2: Clone external code inside container
 
 ```bash
-docker run --rm --network host -v ~/.dtc:/config -it tungbq/devops-toolkit:latest
+docker run --rm --network host -v ~/.dtc:/dtc -it tungbq/devops-toolkit:latest
 # You now in the container terminal
 
 # Now run your cloned script
@@ -49,7 +49,7 @@ Clone the code to the host then mount to container
 
 ```bash
 # Given that we have code somewhere in you machine
-docker run --rm -v "$(pwd)":/root/ansible_workspace --network host -v ~/.dtc:/config -it tungbq/devops-toolkit:latest
+docker run --rm -v "$(pwd)":/root/ansible_workspace --network host -v ~/.dtc:/dtc -it tungbq/devops-toolkit:latest
 # Run the ansible code as usual
 ```
 
@@ -59,7 +59,7 @@ Clone the code to the host then mount code and `.ssh` folder to container
 
 ```bash
 # Given that we have code somewhere in you machine
-docker run --rm -v ~/.ssh:/root/.ssh -v "$(pwd)":/root/ansible_workspace --network host -v ~/.dtc:/config -it tungbq/devops-toolkit:latest
+docker run --rm -v ~/.ssh:/root/.ssh -v "$(pwd)":/root/ansible_workspace --network host -v ~/.dtc:/dtc -it tungbq/devops-toolkit:latest
 # Run the ansible code as usual
 ```
 

diff --git a/docs/usage/awscli_usage.md b/docs/usage/awscli_usage.md
@@ -26,7 +26,7 @@ For instructions on common run modes, visit [**DevOps Toolkit Common Run Mode**]
 ## Use case 1: Configure credentials and list S3 bucket with awscli
 
 ```bash
-docker run --rm --network host -it -v ~/.dtc:/config tungbq/devops-toolkit:latest
+docker run --rm --network host -it -v ~/.dtc:/dtc tungbq/devops-toolkit:latest
 ###############################################
 # Now we are in the docker container terminal #
 ###############################################

diff --git a/docs/usage/azurecli_usage.md b/docs/usage/azurecli_usage.md
@@ -25,7 +25,7 @@ For instructions on common run modes, visit [**DevOps Toolkit Common Run Mode**]
 ## Use case 1: Az login and run command
 
 ```bash
-docker run --rm -it -v ~/.dtc:/config tungbq/devops-toolkit:latest
+docker run --rm -it -v ~/.dtc:/dtc tungbq/devops-toolkit:latest
 
 # Login with AZ CLI
 az login --use-device-code

diff --git a/docs/usage/helm_usage.md b/docs/usage/helm_usage.md
@@ -26,7 +26,7 @@ For instructions on common run modes, visit [**DevOps Toolkit Common Run Mode**]
 ## Use case 1: Deploy an application with Helm
 
 ```bash
-docker run --rm --network host -it -v ~/.dtc:/config tungbq/devops-toolkit:latest
+docker run --rm --network host -it -v ~/.dtc:/dtc tungbq/devops-toolkit:latest
 ###############################################
 # Now we are in the docker container terminal #
 ###############################################

diff --git a/docs/usage/kubectl_usage.md b/docs/usage/kubectl_usage.md
@@ -24,7 +24,7 @@ For instructions on common run modes, visit [**DevOps Toolkit Common Run Mode**]
 Mount the `.kube/config` file from the host to container
 
 ```bash
-docker run --rm --network host -it -v ~/.dtc:/config tungbq/devops-toolkit:latest
+docker run --rm --network host -it -v ~/.dtc:/dtc tungbq/devops-toolkit:latest
 ###############################################
 # Now we are in the docker container terminal #
 ###############################################

diff --git a/docs/usage/python_usage.md b/docs/usage/python_usage.md
@@ -23,15 +23,15 @@ For instructions on common run modes, visit [**DevOps Toolkit Common Run Mode**]
 ## Use case 1: Run python sample code provided in the container
 
 ```bash
-docker run --rm --network host -it -v ~/.dtc:/config tungbq/devops-toolkit:latest
+docker run --rm --network host -it -v ~/.dtc:/dtc tungbq/devops-toolkit:latest
   # You now in the container terminal
 python3 samples/python/rectangle_area_calculator.py
 ```
 
 ## Use case 2: Clone external code inside container
 
 ```bash
-docker run --rm --network host -it -v ~/.dtc:/config tungbq/devops-toolkit:latest
+docker run --rm --network host -it -v ~/.dtc:/dtc tungbq/devops-toolkit:latest
 # You now in the container terminal
 # Clone code
 mkdir python_workspace
@@ -52,7 +52,7 @@ Clone the code to the host then mount to container
 
 ```bash
 # Given that we have code somewhere in you machine
-docker run --rm -v "$(pwd)":/root/python_workspace --network host -it -v ~/.dtc:/config tungbq/devops-toolkit:latest
+docker run --rm -v "$(pwd)":/root/python_workspace --network host -it -v ~/.dtc:/dtc tungbq/devops-toolkit:latest
 # Run the python code as usual
 ```
 

diff --git a/docs/usage/run_mode.md b/docs/usage/run_mode.md
@@ -10,7 +10,7 @@ Command: `docker run <RUN_OPTS> tungbq/devops-toolkit:<TAG>`, some of the common
 - `--rm`: Remove the container after it completes (Ctrl + C or container exit event).
 - `--network host`: Use the host (VM) network.
 - `--name <CONTAINER_NAME>`: Assign a name to the container (e.g: `--name demo001`).
-- `-v <ABS_PATH_ON_THE_HOST>:/config`: Mount a config folder on the host to the container. This allows reusing configurations in the container, like AWS and Azure login sessions (e.g: `-v ~/.dtc:/config`, `-v /tmp/devops-toolkit-config-01:/config`).
+- `-v <ABS_PATH_ON_THE_HOST>:/config`: Mount a config folder on the host to the container. This allows reusing configurations in the container, like AWS and Azure login sessions (e.g: `-v ~/.dtc:/dtc`, `-v /tmp/devops-toolkit-config-01:/config`).
 
 ## Example
 
@@ -48,5 +48,5 @@ docker run --network host -it --name demo001 tungbq/devops-toolkit:latest
 
 ```bash
 mkdir -p ~/.dtc # or other location you want to store the configuration
-docker run --network host -it --rm -v ~/.dtc:/config tungbq/devops-toolkit:latest
+docker run --network host -it --rm -v ~/.dtc:/dtc tungbq/devops-toolkit:latest
 ```
diff --git a/docs/usage/terraform_usage.md b/docs/usage/terraform_usage.md
@@ -22,7 +22,7 @@ For instructions on common run modes, visit [**DevOps Toolkit Common Run Mode**]
 ## Use case 1: Run terraform sample code provided in the container
 
 ```bash
-docker run --rm --network host -it -v ~/.dtc:/config tungbq/devops-toolkit:latest
+docker run --rm --network host -it -v ~/.dtc:/dtc tungbq/devops-toolkit:latest
 # You now in the container terminal
 #  Navigate to Terraform sample
 pushd samples/terraform/basic
@@ -38,7 +38,7 @@ popd
 ## Use case 2: Clone external code inside container
 
 ```bash
-docker run --rm --network host -it -v ~/.dtc:/config tungbq/devops-toolkit:latest
+docker run --rm --network host -it -v ~/.dtc:/dtc tungbq/devops-toolkit:latest
 # You now in the container terminal
 
 # Now run your cloned script
@@ -56,7 +56,7 @@ Clone the code to the host then mount to container
 
 ```bash
 # Given that we have code somewhere in you machine
-docker run --rm -v "$(pwd)":/root/terraform_workspace -v ~/.dtc:/config --network host -it tungbq/devops-toolkit:latest
+docker run --rm -v "$(pwd)":/root/terraform_workspace -v ~/.dtc:/dtc --network host -it tungbq/devops-toolkit:latest
 # Run the terraform code as usual
 ```