From 83d732fdef5e7100ecf4be37d16f19721313cc51 Mon Sep 17 00:00:00 2001 From: commit111 Date: Thu, 2 Jan 2025 13:06:58 -0800 Subject: [PATCH 1/8] added statuses chart --- docs/concepts/services.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/concepts/services.md b/docs/concepts/services.md index af79520ac..bfb4b3fda 100644 --- a/docs/concepts/services.md +++ b/docs/concepts/services.md @@ -21,3 +21,19 @@ Defang manages the deployment process for services. You can learn more about how :::info We plan to add support for other types of services in the future, including serverless functions. ::: + +### Status +Below is an overview of the possible statuses for a service in Defang. + +| Status | Details | +|-|-| +| BUILD_QUEUED | The build is being queued. | +| BUILD_PROVISIONING | The build is provisioning. | +| BUILD_PENDING | The build is pending. | +| BUILD_ACTIVATING | The build is activating. | +| BUILD_RUNNING | The build is running. | +| BUILD_STOPPING | The build is stopping. | +| BUILD_FAILED | The build failed. | +| SERVICE_DEPLOYMENT_PENDING | The deployment is pending. | +| SERVICE_DEPLOYMENT_COMPLETED | The deployment completed. | +| SERVICE_DEPLOYMENT_FAILED | The deployment failed. | From afea899db4b3649389cb11cdefa85eaea6144bfc Mon Sep 17 00:00:00 2001 From: commit111 Date: Thu, 2 Jan 2025 13:14:43 -0800 Subject: [PATCH 2/8] added update_queued --- docs/concepts/services.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/concepts/services.md b/docs/concepts/services.md index bfb4b3fda..66ff72bb3 100644 --- a/docs/concepts/services.md +++ b/docs/concepts/services.md @@ -34,6 +34,7 @@ Below is an overview of the possible statuses for a service in Defang. | BUILD_RUNNING | The build is running. | | BUILD_STOPPING | The build is stopping. | | BUILD_FAILED | The build failed. | +| UPDATE_QUEUED | An update is being queued. | | SERVICE_DEPLOYMENT_PENDING | The deployment is pending. | | SERVICE_DEPLOYMENT_COMPLETED | The deployment completed. | | SERVICE_DEPLOYMENT_FAILED | The deployment failed. | From ea17c8f8ecd5eb844c1bf2010f2a5818d1ad0e5b Mon Sep 17 00:00:00 2001 From: commit111 Date: Thu, 2 Jan 2025 13:15:25 -0800 Subject: [PATCH 3/8] remove extra space --- docs/concepts/services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/services.md b/docs/concepts/services.md index 66ff72bb3..baf2eb138 100644 --- a/docs/concepts/services.md +++ b/docs/concepts/services.md @@ -34,7 +34,7 @@ Below is an overview of the possible statuses for a service in Defang. | BUILD_RUNNING | The build is running. | | BUILD_STOPPING | The build is stopping. | | BUILD_FAILED | The build failed. | -| UPDATE_QUEUED | An update is being queued. | +| UPDATE_QUEUED | An update is being queued. | | SERVICE_DEPLOYMENT_PENDING | The deployment is pending. | | SERVICE_DEPLOYMENT_COMPLETED | The deployment completed. | | SERVICE_DEPLOYMENT_FAILED | The deployment failed. | From 4e1f4be164d8e13612b05ab7fa6e6bcd72451178 Mon Sep 17 00:00:00 2001 From: Linda Lee Date: Fri, 3 Jan 2025 13:34:12 -0800 Subject: [PATCH 4/8] Apply suggestions from code review Co-authored-by: Jordan Stephens --- docs/concepts/services.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/concepts/services.md b/docs/concepts/services.md index baf2eb138..6b87752bb 100644 --- a/docs/concepts/services.md +++ b/docs/concepts/services.md @@ -27,14 +27,14 @@ Below is an overview of the possible statuses for a service in Defang. | Status | Details | |-|-| -| BUILD_QUEUED | The build is being queued. | -| BUILD_PROVISIONING | The build is provisioning. | -| BUILD_PENDING | The build is pending. | -| BUILD_ACTIVATING | The build is activating. | -| BUILD_RUNNING | The build is running. | -| BUILD_STOPPING | The build is stopping. | -| BUILD_FAILED | The build failed. | -| UPDATE_QUEUED | An update is being queued. | -| SERVICE_DEPLOYMENT_PENDING | The deployment is pending. | -| SERVICE_DEPLOYMENT_COMPLETED | The deployment completed. | -| SERVICE_DEPLOYMENT_FAILED | The deployment failed. | +| BUILD_QUEUED | The service update has been received and is now in the queue for its image to be built. | +| BUILD_PROVISIONING | The container orchestrator is provisioning the necessary resources for building your service's image. | +| BUILD_PENDING | The necessary resources to build your service have been provisioned but the build has not yet been initiated. | +| BUILD_ACTIVATING | The container orchestrator is pulling the build container's image and creating the build container. | +| BUILD_RUNNING | The container which builds your service's image is successfully running. | +| BUILD_STOPPING | The container orchestrator has sent a termination signal to the build container and is waiting for the build process to stop. | +| BUILD_FAILED | The build container exited with a non-zero status code. | +| UPDATE_QUEUED | The service update has been received and is now in the queue. | +| SERVICE_DEPLOYMENT_PENDING | The necessary resources to run your service have been provisioned but the service has not yet been initiated. | +| SERVICE_DEPLOYMENT_COMPLETED | Your service has been deployed and is healthy. | +| [SERVICE_DEPLOYMENT_FAILED] | Your service could not be deployed. | From 170739556c2f39625515700b917b02e45eaa9d6a Mon Sep 17 00:00:00 2001 From: commit111 Date: Fri, 3 Jan 2025 13:37:28 -0800 Subject: [PATCH 5/8] fix brackets + heading size --- docs/concepts/services.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/concepts/services.md b/docs/concepts/services.md index 6b87752bb..f6b31ab30 100644 --- a/docs/concepts/services.md +++ b/docs/concepts/services.md @@ -22,8 +22,8 @@ Defang manages the deployment process for services. You can learn more about how We plan to add support for other types of services in the future, including serverless functions. ::: -### Status -Below is an overview of the possible statuses for a service in Defang. +## Status +An overview of the possible statuses for a service in Defang. | Status | Details | |-|-| @@ -37,4 +37,4 @@ Below is an overview of the possible statuses for a service in Defang. | UPDATE_QUEUED | The service update has been received and is now in the queue. | | SERVICE_DEPLOYMENT_PENDING | The necessary resources to run your service have been provisioned but the service has not yet been initiated. | | SERVICE_DEPLOYMENT_COMPLETED | Your service has been deployed and is healthy. | -| [SERVICE_DEPLOYMENT_FAILED] | Your service could not be deployed. | +| SERVICE_DEPLOYMENT_FAILED | Your service could not be deployed. | From 3f29acb6c8ebaa9067c8be806056d023a4be825b Mon Sep 17 00:00:00 2001 From: commit111 Date: Fri, 3 Jan 2025 13:38:38 -0800 Subject: [PATCH 6/8] add more specific heading --- docs/concepts/services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/services.md b/docs/concepts/services.md index f6b31ab30..68351637e 100644 --- a/docs/concepts/services.md +++ b/docs/concepts/services.md @@ -22,7 +22,7 @@ Defang manages the deployment process for services. You can learn more about how We plan to add support for other types of services in the future, including serverless functions. ::: -## Status +## Service Status An overview of the possible statuses for a service in Defang. | Status | Details | From e302dbb8999994b7792b80a49b109845e0e2d2e7 Mon Sep 17 00:00:00 2001 From: commit111 Date: Fri, 3 Jan 2025 16:09:36 -0800 Subject: [PATCH 7/8] add tip on defang compose ps --- docs/concepts/services.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/concepts/services.md b/docs/concepts/services.md index 68351637e..1e2c72444 100644 --- a/docs/concepts/services.md +++ b/docs/concepts/services.md @@ -23,6 +23,7 @@ We plan to add support for other types of services in the future, including serv ::: ## Service Status + An overview of the possible statuses for a service in Defang. | Status | Details | @@ -38,3 +39,7 @@ An overview of the possible statuses for a service in Defang. | SERVICE_DEPLOYMENT_PENDING | The necessary resources to run your service have been provisioned but the service has not yet been initiated. | | SERVICE_DEPLOYMENT_COMPLETED | Your service has been deployed and is healthy. | | SERVICE_DEPLOYMENT_FAILED | Your service could not be deployed. | + +:::tip +You can run the `defang compose ps` command to view a service's status. +::: From 5be15f70eea46147c913118a694f835a5e313af6 Mon Sep 17 00:00:00 2001 From: Linda Lee Date: Mon, 13 Jan 2025 13:57:31 -0800 Subject: [PATCH 8/8] Update docs/concepts/services.md Co-authored-by: Jordan Stephens --- docs/concepts/services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/services.md b/docs/concepts/services.md index 1e2c72444..dd3eb6a83 100644 --- a/docs/concepts/services.md +++ b/docs/concepts/services.md @@ -41,5 +41,5 @@ An overview of the possible statuses for a service in Defang. | SERVICE_DEPLOYMENT_FAILED | Your service could not be deployed. | :::tip -You can run the `defang compose ps` command to view a service's status. +You can run the `defang compose ps` command to view the status of your services. :::