This project was generated using Nx.
- Docker desktop (https://www.docker.com/products/docker-desktop/)
- Minikube (https://minikube.sigs.k8s.io/docs/)
- Install it with homebrew (https://formulae.brew.sh/formula/minikube)
- Kubectl
- Install it with homebrew (https://formulae.brew.sh/formula/kubernetes-cli)
- Mysql
- Install it with homebrew (https://formulae.brew.sh/formula/mysql)
Vault has been already been configured, and its configuration is saved inside the local/vault folder. In order to deploy the local instance of the vault run command docker-compose up from within the vault configuration folder.
Because services that run in Minikube can't access localhost directly, they use host.minikube.internal url to access the localhost. Add 127.0.0.1 host.minikube.internal to hosts file (/etc/hosts) the minikube url to your localhost. This is required because when you locally deploy microservices, it uses .env files for config, and by mapping the minikube url to localhost, you don't have to change .env from localhost to minikube url every time you have to deploy and test everything locally.
Each microservice has its own set of environment variables, by default they are all located in env.dev files. Rename this file to .env and update variables that are specific to your machine (database details)
In order to do that, navigate to the root of archie-microservices and execute node ./deploy-localhost.js i command. (To add console debug messages add -d flag). This command will build docker images of all services and deploy them into local minikube environment.
Note that every time this command is ran, the environment will be purged and set up again from scratch.
To update microservice run node ./deploy-localhost.js u -s user-api. -s flag represents service that you want to update. (Same debug flag applies as for initial deploy command).
Minikube has issue with ingress that makes it impossible to access ingress endpoints. Thankfully there is a work around for this issue (kubernetes/minikube#7332 (comment))
First run this command to get the minikube port docker port minikube | grep 22 the response will look something like 22/tcp -> 127.0.0.1:50341
Now that we know minikube port we can map it to our localhost:3000 using this command sudo ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -N docker@127.0.0.1 -p <minikube_port> -i /Users/<user>/.minikube/machines/minikube/id_rsa -L 3000:127.0.0.1:80 - Replace with the port returned from docker port command and with your username. After this is running, your local cluster should be accessable through localhost:3000.
Because services that run in Minikube can't access localhost directly, they use host.minikube.internal url to access the localhost. Add 127.0.0.1 host.minikube.internal to hosts file (/etc/hosts) the minikube url to your localhost. This is required because when you locally deploy microservices, it uses .env files for config, and by mapping the minikube url to localhost, you don't have to change .env from localhost to minikube url every time you have to deploy and test everything locally.
Each microservice has its own set of environment variables, by default they are all located in env.dev files. Rename this file to .env and update variables that are specific to your machine (database details). For the stress tests uncomment env variables located under comment # Stress test config.
Env for the api located under tests/utils-test-api must be set in order for any script to work.
Datadog helm values are located under local/k6-cluster/datadog-values.example.yml. Copy the file as local/k6-cluster/datadog-values.yml and add required api keys.
Run the setup script using node ./stress-test-minikube.js setup -d.
Deploy services that the wished script is testing using command node ./deploy-localhost.js u -s <service-name> -d. For the script onboarding/full-onboarding.ts the service is called onboarding-api.
K6 settings are located under: local/k6-cluster/k6-operator-custom-resource.yml. Most of the time only API_BASE_URL env needs to be changed.
To run the script execute the following command node ./stress-test-minikube.js run --script=onboarding/full-onboarding.ts. As result of the script, new Kubernetes pods should be spawned, which should be observed and succeed.
K6 is cleaned up every time, the ./stress-test-minikube.js run command is executed. Clean up can also be accomplished by running kubectl delete -f local/k6-cluster/k6-operator-custom-resource.yml
In case the cluster is empty or missing some resources deployed run: node ./stress-test-eks.js setup -d. In case this is the first time you are running this command or the test-api-service was updated also add --build argument
Deploy services using node ./stress-test-eks.js deploy --service=<service_name> -d --build.
After all services are deployed, test can be ran using: node ./stress-test-eks.js run --script=<path to script>
In case you want to stop the script during the execution run: node ./stress-test-eks.js stop
After you are finished with testing run node ./stress-test-eks.js clean. The command will clean up all the resources. Some "Not found" errors during this command are expected. Please check running pods to validate that the services were cleaned up.
This project was generated using Nx.
🔎 Smart, Fast and Extensible Build System
Nx supports many plugins which add capabilities for developing different types of applications and different tools.
These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.
Below are our core plugins:
- React
npm install --save-dev @nrwl/react
- Web (no framework frontends)
npm install --save-dev @nrwl/web
- Angular
npm install --save-dev @nrwl/angular
- Nest
npm install --save-dev @nrwl/nest
- Express
npm install --save-dev @nrwl/express
- Node
npm install --save-dev @nrwl/node
There are also many community plugins you could add.
Run nx g @nrwl/react:app my-app to generate an application.
You can use any of the plugins above to generate applications as well.
When using Nx, you can create multiple applications and libraries in the same workspace.
Run nx g @nrwl/react:lib my-lib to generate a library.
You can also use any of the plugins above to generate libraries as well.
Libraries are shareable across libraries and applications. They can be imported from @archie-webapps/mylib.
Run nx serve my-app for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
Run nx g @nrwl/react:component my-component --project=my-app to generate a new component.
Run nx build my-app to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.
Run nx test my-app to execute the unit tests via Jest.
Run nx affected:test to execute the unit tests affected by a change.
Run nx e2e my-app to execute the end-to-end tests via Cypress.
Run nx affected:e2e to execute the end-to-end tests affected by a change.
Run nx graph to see a diagram of the dependencies of your projects.
Visit the Nx Documentation to learn more.
Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.
Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.
Visit Nx Cloud to learn more.