diff --git a/docs/guides/support-microservices-in-ephemeral-environments-with-nginx.md b/docs/guides/support-microservices-in-ephemeral-environments-with-nginx.md index fe99477..568f9ea 100644 --- a/docs/guides/support-microservices-in-ephemeral-environments-with-nginx.md +++ b/docs/guides/support-microservices-in-ephemeral-environments-with-nginx.md @@ -10,7 +10,7 @@ Uffizzi, being cloud-native, allows you to bring your microservices architecture The next component of the microservices architecture is networking. How you configure networking for your ephemeral environments depends on your application architecture. If you have multiple independent client-side and server-side services talking through HTTP/S, for example, an Angular frontend talking to Node backend, networking between these services can be achieved using Nginx as a reverse proxy. Some other cases where we’ve used Nginx to help projects onboard to ephemeral environments are: -- More than one microservice exposed publicly: if your application has multiple public-facing services, you’ll need to put them behind Nginx (or an alternate reverse proxy such as Traefik). The reverse proxy will receive your traffic, and route requests for different services accordingly. Currently, Uffizzi does not support adding multiple "ingresses" (multiple entry ports) into your application. For example, if you have one service named personal-account, exposed publicly on port `3000`, and another service named team-account, exposed publicly on port `3001`, natively (without Nginx), you can expose either `3000` or `3001` on your ephemeral environment to receive external requests using the [ingress field in your compose file](../references/compose-spec/#ingress-required). With Nginx added, you can put both services behind Nginx, expose Nginx to receive HTTP/S traffic, and forward requests coming to Nginx to your services. +- More than one microservice exposed publicly: if your application has multiple public-facing services, you’ll need to put them behind Nginx (or an alternate reverse proxy such as Traefik). The reverse proxy will receive your traffic, and route requests for different services accordingly. Currently, Uffizzi does not support adding multiple "ingresses" (multiple entry ports) into your application. For example, if you have one service named personal-account, exposed publicly on port `3000`, and another service named team-account, exposed publicly on port `3001`, natively (without Nginx), you can expose either `3000` or `3001` on your ephemeral environment to receive external requests using the [ingress field in your compose file](../references/compose-spec). With Nginx added, you can put both services behind Nginx, expose Nginx to receive HTTP/S traffic, and forward requests coming to Nginx to your services. - More than one port needs to be accessed publicly (primarily applicable for monoliths): if a service has more than one exposed port that needs to be accessed publicly, adding Nginx as a reverse proxy will help you achieve this elegantly. diff --git a/docs/troubleshooting/debugging.md b/docs/troubleshooting/debugging.md index 20584bd..d56b067 100644 --- a/docs/troubleshooting/debugging.md +++ b/docs/troubleshooting/debugging.md @@ -32,7 +32,7 @@ Once you’ve added a valid compose file, you’ll be able to test it by clickin ### Build Errors If, for example, your Uffizzi is unable to locate your application Dockerfile given in the `docker-compose.uffizzi.yml`, Uffizzi will fail to build the application image. If there are other issues in your Dockerfile, for example, issues with conflicting dependencies, in this case too, building the image will fail, and hence, Uffizzi will fail to create/modify an ephemeral environment. In either case, you would want to check the build logs. -To identify issues with building your application image, head over to the Uffzzi dashboard and select the project you’re debugging (you might have one or multiple projects listed on the dashboard). You will then see all currently active ephemeral environments for this project. If you are debugging a particular ephemeral environment for a specific PR, you can select that environment. Typically, the timestamp of when the environment was updated along with the Preview URL, which looks something like _https://pr-10-deployment-1234-your-application.app.uffizzi.com_, will help you identify if that environment corresponds to your PR. +To identify issues with building your application image, head over to the Uffzzi dashboard and select the project you’re debugging (you might have one or multiple projects listed on the dashboard). You will then see all currently active ephemeral environments for this project. If you are debugging a particular ephemeral environment for a specific PR, you can select that environment. Typically, the timestamp of when the environment was updated along with the Preview URL, which looks something like `_https://pr-10-deployment-1234-your-application.app.uffizzi.com_`, will help you identify if that environment corresponds to your PR. Once you select the environment you are debugging, you will see a list of all the containers in that project. If a container has failed (either while the image-building process or while running the container), you will see it marked failed on the Uffizzi UI.