-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
modified the documentation with the new Makefile commands
- Loading branch information
Showing
12 changed files
with
401 additions
and
394 deletions.
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
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 |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # Quick Start - 6. Setup the APIs and frontend | ||
|
|
||
| In this final section, we are going to setup two APIs and a frontend application. We will deploy them to the `default` namespace of our kubernetes cluster. | ||
|
|
||
| We will cover how to build, push, and run the frontend application and APIs. The frontend code can be found [here](./api/users/README.md), and the APIs can be found here: | ||
|
|
||
| - `users` [[see](./api/users/)] | ||
| - `articles` [[see](./api/articles/)] | ||
|
|
||
| ## Frontend | ||
|
|
||
| ### Build and push | ||
|
|
||
| After modifying the frontend code, and creating a new version. We can build and push the new version onto a docker registry. We can modify the name of the docker image and the repository in the frontend's Makefile. | ||
|
|
||
| ``` | ||
| make build_push_frontend | ||
| ``` | ||
|
|
||
| ### Run the frontend on kubernetes | ||
|
|
||
| To run the frontend on our kubernetes cluster, we use the following command: | ||
|
|
||
| ``` | ||
| make run_frontend_k8s | ||
| ``` | ||
|
|
||
| > To use another image than the default one, we need to change the kubernetes manifests in: `./kubernetes/frontend/frontend.yaml`, and specify the new image name/repository. | ||
| We can access the frontend at this URL: http://tagenal | ||
|
|
||
|
|
||
| ### Stop the frontend | ||
|
|
||
| To stop the frontend, use the following command: | ||
|
|
||
| ``` | ||
| make stop_frontend_k8s | ||
| ``` | ||
|
|
||
|
|
||
| ## APIs | ||
|
|
||
| ### Build and Push docker images | ||
|
|
||
| After modifying the codebase. A new version of the docker image can be built and pushed to a public docker repository. We do so using the following command: | ||
|
|
||
| ``` | ||
| make build_push_apis | ||
| ``` | ||
|
|
||
| ### Run the APIs on kubernetes | ||
|
|
||
| To run the APIs on our kubernetes cluster we use the following command. This will create the two APIs in the `default` namespace of our kubernetes cluster. | ||
|
|
||
| ``` | ||
| make run_apis_k8s | ||
| ``` | ||
|
|
||
| > To use another image than the default ones, we can change the kubernetes manifests in: `./kubernetes/api/**/*_api_server.yaml`, and specify the proper image names. | ||
| Now that our APIs are up and running, we can access them using the ingress routes that were automatically defined in the above command. The URLs are: | ||
|
|
||
| - http://api.tagenal/users | ||
| - http://api.tagenal/articles | ||
|
|
||
| ### Stop the APIs | ||
|
|
||
| To stop the APIs we run the following command: | ||
|
|
||
| ``` | ||
| make stop_apis_k8s | ||
| ``` |
This file was deleted.
Oops, something went wrong.
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,19 +1,21 @@ | ||
| # Setup Jaeger | ||
| # Quick Start - 2. Setup Jaeger | ||
|
|
||
| This section will cover how to setup the `observability` namespace of our kubernetes cluster. | ||
| This section will cover how to setup our first kubernetes namespace: `observability`. This namespace will host our observability stack, for now only composed of Jaeger. | ||
|
|
||
| ## Setup Jaeger | ||
|
|
||
| We use the following command for a few things. It will create the whole `observability` namespace and the required CRDs. It will also add Jaeger configuration to the Vitess cluster and to Traefik. | ||
| The following command will do a few things for us. It will create the `observability` namespace, and the CRDs that Jaeger needs to successfully run on kubernetes. Then, it will | ||
|
|
||
| ``` | ||
| make setup_jaeger | ||
| ``` | ||
|
|
||
| Tagenal is mostly experiment-oriented and not production-oriented. We then use the `AllInOne` configuration of Jaeger, which will greatly ease the deployment. | ||
|
|
||
| The command also created the ingress route to access Jaeger dashboard. Which can be access at this URL: http://jaeger.tagenal. On this interface we can see the trace of our services. | ||
| By using minikube dashboard or `kubectl` we can observe the successful deployment of Jaeger. | ||
|
|
||
| ## Next step | ||
| ## Next | ||
|
|
||
| The next step is to run the APIs in our kubernetes cluster. Which is detailed [in the next section](./setup-apis.md). | ||
| For now, we can't access Jaeger UI, we will cover that in the next section thanks to Traefik Proxy. Next step is [here](./setup-traefik.md). | ||
|
|
||
| <!-- The next step is to run the APIs in our kubernetes cluster. Which is detailed [in the next section](./setup-apis.md). --> |
Oops, something went wrong.