From c3b6ee6a31942badeb1cf6a1527a8e21f7a5a9ae Mon Sep 17 00:00:00 2001 From: nprimo Date: Thu, 11 Apr 2024 10:39:14 +0100 Subject: [PATCH] docs(crud-master): give option to use alternatives to VirtualBox --- subjects/devops/crud-master-py/README.md | 6 +++--- subjects/devops/crud-master-py/audit/README.md | 4 ++-- subjects/devops/crud-master/README.md | 6 +++--- subjects/devops/crud-master/audit/README.md | 8 ++++---- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/subjects/devops/crud-master-py/README.md b/subjects/devops/crud-master-py/README.md index 0ddf647c..a05eddb9 100644 --- a/subjects/devops/crud-master-py/README.md +++ b/subjects/devops/crud-master-py/README.md @@ -20,7 +20,7 @@ The API gateway will communicate in HTTP with the `inventory` service and using RabbitMQ for `billing` service. In this exercise you will need to install Python3 (with Flask, SQLAlchemy and -other packages), PostgreSQL, RabbitMQ, Postman, VirtualBox and Vagrant. +other packages), PostgreSQL, RabbitMQ, Postman, VirtualBox (or an equivalent software such as VMware) and Vagrant. While it may seem overwhelming at first, there are a lot of resources available both on official website and on community blogs about setting up those tools. @@ -184,7 +184,7 @@ for each endpoint. Feel free to implement any extra feature as you see fit. ##### General overview -You will use VirtualBox and Vagrant to set up three different VMs in order to +You will Vagrant to set up three different VMs in order to test the interactions and correctness of responses between your APIs infrastructure. @@ -228,7 +228,7 @@ microservices should have any credential hard coded in the source code. Your configuration will work properly for the following commands (executed from the root of the project): -- `vagrant up --provider virtualbox`: Starts all the VMs. +- `vagrant up`: Starts all the VMs. - `vagrant status`: Shows the status for all the VMs. - `vagrant ssh `: Will let you access the VM through SSH. diff --git a/subjects/devops/crud-master-py/audit/README.md b/subjects/devops/crud-master-py/audit/README.md index 558e86d9..fca89606 100644 --- a/subjects/devops/crud-master-py/audit/README.md +++ b/subjects/devops/crud-master-py/audit/README.md @@ -1,6 +1,6 @@ #### Functional -##### Before we start, let's check we have the necessary tools to perform the tests. You should make sure VirtualBox, Vagrant and Postman are installed, if not you should install them. +##### Before we start, let's check we have the necessary tools to perform the tests. You should make sure VirtualBox (or an equivalent software), Vagrant and Postman are installed, if not you should install them. #### Documentation @@ -10,7 +10,7 @@ #### VM Configuration -##### In the directory of the project run `vagrant up --provider virtualbox` and then run `vagrant status`. +##### In the directory of the project run `vagrant up` and then run `vagrant status`. ###### Can you confirm that the three VMs (`gateway-vm`, `inventory-vm` and `billing-vm`) are up and running? diff --git a/subjects/devops/crud-master/README.md b/subjects/devops/crud-master/README.md index b9ee254c..dc757874 100644 --- a/subjects/devops/crud-master/README.md +++ b/subjects/devops/crud-master/README.md @@ -16,7 +16,7 @@ We will setup a movie streaming platform, where one API (`inventory`) will have The API gateway will communicate in HTTP with `inventory` and using RabbitMQ for `billing`. -In this exercise you will need to install Node.js (with Express, Sequelize and other packages), PostgreSQL, RabbitMQ, Postman, VirtualBox and Vagrant. +In this exercise you will need to install Node.js (with Express, Sequelize and other packages), PostgreSQL, RabbitMQ, Postman, VirtualBox (or any equivalent software such as VMWare) and Vagrant. While it may seems overwhelming at first there is a lot of resources available both on official website and on community blogs about setting up those tools. Also the specific configuration details may change from platform to platform so don't hesitate to play around with it and be sure everything is installed correctly before to move on. @@ -149,7 +149,7 @@ As an introduction to the art of great documentation you must create an OpenAPI ##### General overview -You will use VirtualBox and Vagrant to setup three different VMs in order to test the interactions and correctness of responses between your APIs infrastructure. +You will use Vagrant to setup three different VMs in order to test the interactions and correctness of responses between your APIs infrastructure. Vagrant is an open-source software that helps you create and manage virtual machines. With Vagrant, you can create a development environment that is identical to your production environment, which makes it easier to develop, test, and deploy your applications. @@ -178,7 +178,7 @@ Your `.env` file should contain all the necessary credentials and none of the mi Your configuration will work properly for the following commands (executed from the root of the project): -- `vagrant up --provider virtualbox`: Starts all the VMs. +- `vagrant up`: Starts all the VMs. - `vagrant status`: Shows the status for all the VMs. - `vagrant ssh `: Will let you access the VM through SSH. diff --git a/subjects/devops/crud-master/audit/README.md b/subjects/devops/crud-master/audit/README.md index d6408192..a722bec2 100644 --- a/subjects/devops/crud-master/audit/README.md +++ b/subjects/devops/crud-master/audit/README.md @@ -1,22 +1,22 @@ #### Functional -##### Before we start, let's check we have the necessary tools to perform the tests. You should make sure VirtualBox, Vagrant and Postman are installed, if not you should install them. +##### Before we start, let's check we have the necessary tools to perform the tests. You should make sure VirtualBox (or an equivalent software), Vagrant and Postman are installed, if not you should install them. #### Documentation ##### Take a look at the `README.md` file provided by the student. -###### Does the file includes enough context and details to understand and run the project? +###### Does the file include enough context and details to understand and run the project? #### VM Configuration -##### In the directory of the project run `vagrant up --provider virtualbox` and then run `vagrant status`. +##### In the directory of the project run `vagrant up` and then run `vagrant status`. ###### Can you confirm that the three VMs (`gateway-vm`, `inventory-vm` and `billing-vm`) are up and running? ##### Locate the `.env` file in the root of the project, run `cat .env`: -###### Does the output contains all the necessary credentials for the microservices to run properly? +###### Does the output contain all the necessary credentials for the microservices to run properly? ###### Is the source code free from any credential that could have been added to the `.env` file?