Skip to content

Commit

Permalink
Spelling and grammar fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
yevster committed Jan 28, 2020
1 parent d4a1ffa commit 09fcd14
Show file tree
Hide file tree
Showing 14 changed files with 34 additions and 33 deletions.
2 changes: 1 addition & 1 deletion 00-setup-your-environment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ docker run -d azurejavalab.azurecr.io/azurejavalab:2020.01

Visual Studio code makes it easy to edit files and run commands inside a container all in one single, fluid interface. If you don't have VS Code installed, [install it now](https://code.visualstudio.com).

With Visual Studio Code installed, open the page for the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension, and click "Install". If prompted to allow the browser to open Visual Studio Code, allow it.
With Visual Studio Code installed, open the page for the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension and click "Install". If prompted to allow the browser to open Visual Studio Code, allow it.

Visual Studio Code will open, showing the description of the Remote Containers extension. Click on the green install button on that page to install the extension:

Expand Down
2 changes: 1 addition & 1 deletion 01-create-a-cluster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ First, you will need to come up with a name for your Azure Spring Cloud instance

To save minimize, set the variable `RESOURCE_GROUP_NAME` to the name of the resource group created in the previous section. Set the variable `SPRING_CLOUD_NAME` to the name of the Azure Spring Cloud instance to be created:

>🛑Be sure to substitute your own values for `RESOURCE_GROUP_NAME` and `SPRING_CLOUD_NAME` as desribed above.
>🛑Be sure to substitute your own values for `RESOURCE_GROUP_NAME` and `SPRING_CLOUD_NAME` as described above.
```bash
RESOURCE_GROUP_NAME=spring-cloud-lab
Expand Down
5 changes: 2 additions & 3 deletions 02-build-a-simple-spring-boot-microservice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,7 @@ kill %1

## Create and deploy the application on Azure Spring Cloud

This section shows how to create an app instance, and then deploy your
code to it.
This section shows how to create an app instance and then deploy your code to it.

In order to create the app instance graphically, you can use [the Azure portal](https://portal.azure.com/?WT.mc_id=azurespringcloud-github-judubois):

Expand Down Expand Up @@ -112,7 +111,7 @@ Go to [the Azure portal](https://portal.azure.com/):

You can now use cURL again to test the `/hello` endpoint, this time served by Azure Spring Cloud. For example.

```
```bash
curl https://primary:BBQM6nsYnmmdQREXQINityNx63kWUbjsP7SIvqKhOcWDfP6HJTqg27klMLaSfpTB@rwo1106f.test.azuremicroservices.io/simple-microservice/default/hello/
```

Expand Down
4 changes: 2 additions & 2 deletions 03-configure-monitoring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Access Spring Boot applications logs and distributed tracing to understand commo

There are actually three ways to access your application's logs: [Azure Storage](https://docs.microsoft.com/en-us/azure/storage/common/storage-introduction/), [Azure Events Hub](https://docs.microsoft.com/en-us/azure/event-hubs/), and [Log Analytics](https://docs.microsoft.com/en-us/azure/azure-monitor/log-query/get-started-portal). We will focus here on Log Analytics as it's the most common one, and as it's integrated into Azure Spring Cloud.

[Log Analytics](https://docs.microsoft.com/en-us/azure/azure-monitor/log-query/get-started-portal/) is part of [Azure Monitor](https://azure.microsoft.com/en-us/services/monitor/), which is well-integrated into Azure Spring Cloud, and which we will also use for metrics monitoring.
[Log Analytics](https://docs.microsoft.com/en-us/azure/azure-monitor/log-query/get-started-portal/) is part of [Azure Monitor](https://azure.microsoft.com/en-us/services/monitor/), which is well-integrated into Azure Spring Cloud and which we will also use for metrics monitoring.

Having completed the setup in [Section 00](../00-setup-your-environment/README.md), you should have a Log Analytics workspace named `sclab-la-<unique string>` in your resource group for this workshop. We must now configure our Azure Spring Cloud instance to send its data to this workspace.

- Go to the "Overview" page of your Azure Spring Cloud instance, and select "Diagnostic settings" in the "Monitoring" section of the navigation pane.
- Go to the "Overview" page of your Azure Spring Cloud instance and select "Diagnostic settings" in the "Monitoring" section of the navigation pane.
- Delete any diagnostic settings you may see there.
- Click on "Add diagnostic setting" and configure your instance to send all its logs to the Log analytics workspace that we just created.
- Fill in the values as shown here and click "Save".
Expand Down
6 changes: 3 additions & 3 deletions 04-configure-a-spring-cloud-config-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ When a token is generated, leave that tab open until the end of this section.
## Configure Azure Spring Cloud to access the Git repository
- Go to the [the Azure portal](https://portal.azure.com/?WT.mc_id=azurespringcloud-github-judubois).
- Go to the overview page of your Azure Spring Cloud server, and select "Config server" in the menu
- Go to [the Azure portal](https://portal.azure.com/?WT.mc_id=azurespringcloud-github-judubois).
- Go to the overview page of your Azure Spring Cloud server and select "Config server" in the menu
- Configure the repository we previously created:
- Add the repository URL, for example `https://github.com/jdubois/azure-spring-cloud-config.git`.
- Add the repository URL, for example `https://github.com/jdubois/azure-spring-cloud-config.git`.

>💡 Make you include the `.git` ending in the URL.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Insert this text in the text area that states "Type your queries here or click o
```sql
AppPlatformLogsforSpring
| where AppName == "spring-cloud-microservice"
| project TimeGenerated, Log
| project TimeGenerated, Log
| order by TimeGenerated desc
| limit 50
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

__This guide is part of the [Azure Spring Cloud training](../README.md)__

Build a reactive Spring Boot microservice, that uses the [Spring reactive stack](https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html) and is binded to a [Cosmos DB database](https://docs.microsoft.com/en-us/azure/cosmos-db/) in order to access a globally-distributed database with optimum performance.
Build a reactive Spring Boot microservice that uses the [Spring reactive stack](https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html) and is bound to a [Cosmos DB database](https://docs.microsoft.com/en-us/azure/cosmos-db/) in order to access a globally-distributed database with optimum performance.

---

Expand Down Expand Up @@ -182,7 +182,7 @@ Azure Spring Cloud can automatically bind the Cosmos DB database we created to o
- Go to `Service bindings`
- Click on `Create service binding``
- Give your binding a name, for example `cosmosdb-city`
- Select the Cosmos DB account and database we created, and keep the default `sql` API type
- Select the Cosmos DB account and database we created and keep the default `sql` API type
- In the drop-down list, select the primary master key
- Click on `Create` to create the database binding

Expand Down
9 changes: 5 additions & 4 deletions 07-build-a-spring-boot-microservice-using-mysql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ az spring-cloud app create -n weather-service

In [Section 6](../06-build-a-reactive-spring-boot-microservice-using-cosmosdb/README.md), we created a service binding to inject CosmosDB configuration into an Azure Spring Cloud microservice.

Now, let's do the same thing to inject connectino information for our MySQL database into the new `weather-service` microservice. This time, we'll do it from the command line:
Now, let's do the same thing to inject connection information for our MySQL database into the new `weather-service` microservice. This time, we'll do it from the command line:

> 💡Make sure you use the same shell session that you've been using for the previous steps in this section.
Expand All @@ -84,13 +84,14 @@ az spring-cloud app binding mysql add \
--key "$MYSQL_PASSWORD"
```
You can, if you wish, view the newly-created service binding in [Azure Portal](https://portal.azure.com/?WT.mc_id=azurespringcloud-github-judubois):
You can, if you wish, view the newly created service binding in [Azure Portal](https://portal.azure.com/?WT.mc_id=azurespringcloud-github-judubois):
- Navigate to your Azure Spring Cloud Instance
- Click on Apps
- Click on `weather-service`.
- Click on Service Bindings.
You should see the newly-created weather binding listed: `mysql-weather`. If you click on it, you can see the MySQL connection information:
You should see the newly created weather binding listed: `mysql-weather`. If you click on it, you can see the MySQL connection information:
![MySQL Service Binding](media/03-bind-service-mysql.png)
Expand Down Expand Up @@ -250,7 +251,7 @@ cd ..

- Go to "Apps" in your Azure Spring Cloud instance.
- Verify that `weather-service` has a `Discovery status` which says `UP(1),DOWN(0)`. This shows that it is correctly registered in the Spring Cloud Service Registry.
- Select `weather-service` to have more information on the microservice.
- Select `weather-service` to have `m`ore information on the microservice.
- Copy/paste the "Test Endpoint" that is provided.

You can now use cURL to test the `/weather/city` endpoint. For example, to test for `Paris, France` city, append to the end of the test endpoint: `/weather/city?name=Paris%2C%20France`.
Expand Down
2 changes: 1 addition & 1 deletion 08-build-a-spring-cloud-gateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ At the end of the application's `pom.xml` file (just before the closing `</proje

## Configure the application

Rename `src/main/resources/application.properties` to `src/main/resources/application.yml`, and add the following configuration:
Rename `src/main/resources/application.properties` to `src/main/resources/application.yml` and add the following configuration:

```yaml
spring:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ __[https://spring-training.azureedge.net/](https://spring-training.azureedge.net

For your information, this website is hosted on Azure Storage and served through Azure CDN for optimum performance.

Go to [https://spring-training.azureedge.net/](https://spring-training.azureedge.net/), input your Spring Cloud Gateway's public URL in the text field, and click on "Go". You should see the following screen:
Go to [https://spring-training.azureedge.net/](https://spring-training.azureedge.net/), input your Spring Cloud Gateway's public URL in the text field and click on "Go". You should see the following screen:

![VueJS front-end](media/01-vuejs-frontend.png)

Expand Down Expand Up @@ -92,10 +92,10 @@ In the "Distributed tracing" menu in Azure Portal, you should now have access to

Now that distributed tracing is enabled, we can scale applications depending on our needs.

- Go to the [the Azure portal](https://portal.azure.com/?WT.mc_id=azurespringcloud-github-judubois).
- Go to the overview page of your Azure Spring Cloud server, and select "Apps" in the menu.
- Select one service, and click on "Scale"
- Modify the number of instances, or change the CPU/RAM of the instance
- Go to [the Azure portal](https://portal.azure.com/?WT.mc_id=azurespringcloud-github-judubois).
- Go to the overview page of your Azure Spring Cloud server and select "Apps" in the menu.
- Select one service and click on "Scale"
- Modify the number of instances or change the CPU/RAM of the instance

![Application scaling](media/04-application-scaling.png)

Expand Down
9 changes: 5 additions & 4 deletions 10-blue-green-deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

__This guide is part of the [Azure Spring Cloud training](../README.md)__

Deploy new versions of applications in a staging environment, and switch between staging and production with Azure Spring Cloud.
Deploy new versions of applications in a staging environment and switch between staging and production with Azure Spring Cloud.

---

Expand Down Expand Up @@ -54,7 +54,7 @@ az spring-cloud app deployment create --name green --app weather-service --jar-p
cd ..
```

Once the application is deployed, if you go to [https://spring-training.azureedge.net/](https://spring-training.azureedge.net/) you will still have the same data, as the new version of the microservice is now in a staging area, and not in production yet.
Once the application is deployed, if you go to [https://spring-training.azureedge.net/](https://spring-training.azureedge.net/) you will still have the same data, as the new version of the microservice is now in a staging area and not in production yet.

Navigate to the Azure Spring Cloud Instance in [the Azure portal](https://portal.azure.com/?WT.mc_id=azurespringcloud-github-judubois) and click on "Deployments" (under Settings). You should now see the "green" deployment in the "Staging Deployment" column:

Expand All @@ -67,6 +67,7 @@ curl https://***.test.azuremicroservices.io/weather-service/green/weather/city?n
```

And you should see the result of the recent modification:

```json
{"city":"Paris, France","description":"It's always sunny on Azure Spring Cloud","icon":"weather-sunny"}
```
Expand All @@ -82,7 +83,7 @@ az spring-cloud app set-deployment -n weather-service --deployment green
Another solution is to use [the Azure portal](https://portal.azure.com/?WT.mc_id=azurespringcloud-github-judubois):

- Find your Azure Spring Cloud instance
- Click on the "deployement" menu
- Click on the "deployment" menu
- Select the `weather-service` application and click on "Set deployment"

> If you want to reuse a deployment name, you need first to delete the previous deployment under that name:
Expand All @@ -91,7 +92,7 @@ Another solution is to use [the Azure portal](https://portal.azure.com/?WT.mc_id
> az spring-cloud app deployment delete --name green --app weather-service
> ```
Once you have swapped deployments, and that `green` is active, you need to wait a few seconds for the Spring Cloud Service Registry to synchronize and use this new version from the `gateway` application. You will then be able to see the new modified data:
Once you have swapped deployments and see that `green` is active, you need to wait a few seconds for the Spring Cloud Service Registry to synchronize and use this new version from the `gateway` application. You will then be able to see the new modified data:
![Green deployment](media/01-green-deployment.png)
Expand Down
2 changes: 1 addition & 1 deletion 11-configure-ci-cd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Then, in your GitHub project, select `Settings > Secrets` and add a new secret c

## Create a GitHub action

Inside the `weather-service` directory, create a new directory called `.github/workflows` and add a file called `azure-spring-cloud.yml` in it. This file is a GitHub workflow, and will use the secret we just configured above, in order to deploy the application to your Azure Spring Cloud instance.
Inside the `weather-service` directory, create a new directory called `.github/workflows` and add a file called `azure-spring-cloud.yml` in it. This file is a GitHub workflow and will use the secret we just configured above to deploy the application to your Azure Spring Cloud instance.

In that file, copy/paste the following content, performing the indicated substitutions:

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Images have a black 5px border around them, as Azure's default theme is white an
You can choose any tool to do those border, here's how we do it:

- Use the GIMP
- Go to `Filters -> Decor -> Add border...`
- Configure the border to be black, and only 5 pixels width
- Go to `Filters -> Decor -> Add border...`
- Configure the border to be black and only 5 pixels width

## Contributors

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This lab is based on a public workshop created by [Julien Dubois](https://twitte

## What you should expect

This is not the official documentation, but an opinionated training.
This is not the official documentation but an opinionated training.

It is a hands-on training, and it will use the command line extensively. The idea is to get coding very quickly and play with the platform, from a simple demo to far more complex examples.

Expand Down Expand Up @@ -64,11 +64,11 @@ Build a [Spring Cloud Gateway](https://spring.io/projects/spring-cloud-gateway)

## [09 - Putting it all together, a complete microservice stack](09-putting-it-all-together-a-complete-microservice-stack/README.md)

Use a front-end to access graphically our complete microservice stack. Monitor our services with Azure Spring Cloud's distributed tracing mechanism, and scale our services depending on our needs.
Use a front-end to access graphically our complete microservice stack. Monitor our services with Azure Spring Cloud's distributed tracing mechanism and scale our services depending on our needs.

## [10 - Blue/Green deployment](10-blue-green-deployment/README.md)

Deploy new versions of applications in a staging environment, and switch between staging and production with Azure Spring Cloud.
Deploy new versions of applications in a staging environment and switch between staging and production with Azure Spring Cloud.

## [11 - Configure CI/CD](11-configure-ci-cd/README.md)

Expand Down

0 comments on commit 09fcd14

Please sign in to comment.