Skip to content

Commit 614d393

Browse files
Update how-it-works.mdx
More branding and consistency changes
1 parent 9034936 commit 614d393

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/intro/how-it-works.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
11
---
22
sidebar_position: 250
33
title: How it Works
4-
description: Overview of the Defang platform and how it works in your cloud
4+
description: Overview of the Defang architecture and how it works in your cloud
55
---
66

77
# How Defang Works
88

9-
Defang is a radically simpler way to develop, deploy, and debug applications in your favourite cloud. Defang abstracts away the complexity of cloud infrastructure, providing you with a streamlined experience. Defang works by provisioning a "cd" service and a small set of resources in your cloud account. These services enable Defang to orchestrate deployments for you in your cloud account from the Defang CLI. Here's how it works.
9+
Defang is an AI-assisted tool that lets you take your app from Docker Compose to a secure and scalable deployment on your favorite cloud in minutes. Defang abstracts away the complexity of cloud infrastructure, providing you with a streamlined experience. Defang works by provisioning a "CD" service and a small set of resources in your cloud account. These services enable Defang to orchestrate deployments for you in your cloud account from the `defang` CLI. Here's how it works.
1010

1111
## Bootstrapping
1212

13-
The first time you deploy with Defang, a new `cd` service will be created in your cloud account. This service acts as an intermediary between you and your cloud provider. It will set up a grpc endpoint with which the Defang CLI can communicate. When the cli sends a request to trigger a deployment, for example, this service will orchestrate the build and deployment process—interfacing with the cloud APIs on your behalf. We will also create the necessary resources to support the defang system. This includes things like roles, a storage space, an image repository, certificates, etc. The specific resources created depend on the cloud provider.
13+
The first time you deploy with Defang, a new `CD` service will be created in your cloud account. This service acts as an intermediary between you and your cloud provider. It will set up a grpc endpoint with which the `defang` CLI can communicate. When the CLI sends a request to trigger a deployment, for example, this service will orchestrate the build and deployment process—interfacing with the cloud APIs on your behalf. We will also create the necessary resources to support the Defang system. This includes things like roles, a storage space, an image repository, certificates, etc. The specific resources created depend on the cloud provider.
1414

1515
Our architecture and AWS implementation has passed a ["well-architected"](https://docs.aws.amazon.com/wellarchitected/latest/framework/welcome.html) review. We are in the process for obtaining similar qualifications with Digital Ocean and Google Cloud.
1616

1717
You can learn more about the specifics by visiting our [provider docs](/docs/category/providers).
1818

1919
:::info
20-
The `cd` service does not run all the time. It is only used when you deploy a new service or update an existing service. Once it has finished deploying your service, it will shut itself down.
20+
The `CD` service does not run all the time. It is only used when you deploy a new service or update an existing service. Once it has finished deploying your service, it will shut itself down.
2121
:::
2222

2323
```mermaid
2424
2525
flowchart TD
2626
subgraph workspace["Local Workspace"]
2727
compose[compose.yaml]
28-
cli("Defang CLI")
28+
CLI("Defang CLI")
2929
end
3030
3131
subgraph cloud["Cloud"]
3232
sdk(("SDK"))
33-
cd(cd)
33+
CD(CD)
3434
kaniko(Kaniko)
3535
3636
subgraph services[" "]
@@ -40,34 +40,34 @@ flowchart TD
4040
end
4141
end
4242
43-
compose --> cli
43+
compose --> CLI
4444
45-
cli <--> cd
46-
cd --> kaniko
47-
cd --> sdk
45+
CLI <--> CD
46+
CD --> kaniko
47+
CD --> sdk
4848
sdk --> services
4949
5050
```
5151

5252
## Orchestrating Deployments
5353

54-
The Defang `cd` service acts as an intermediary between you and your cloud provider. This service receives deployment requests from the Defang CLI. Once a request has been received, `cd` orchestrates the process of building application images from your source code, and then continues to provision the necessary resources to deploy your application.
54+
The Defang `CD` service acts as an intermediary between you and your cloud provider. This service receives deployment requests from the `defang` CLI. Once a request has been received, `CD` orchestrates the process of building application images from your source code, and then continues to provision the necessary resources to deploy your application.
5555

5656
:::info
57-
The `defang` cli will upload your source code to a storage destination within your cloud. Your source code is never processed by Defang's servers.
57+
The `defang` CLI will upload your source code to a storage destination within your cloud. Your source code is never processed by Defang's servers.
5858
:::
5959

6060
## Building Images
6161

62-
When you deploy a new service, Defang will build a Docker image from your source code. This source code is uploaded by the `defang` cli to a storage destination in your cloud account. The Defang `cd` service will then retrieve it and determine if each of your service's images need to be rebuilt. If rebuilding is necessary, `cd` will start a new container for each build it needs to complete.
62+
When you deploy a new service, Defang will build a Docker image from your source code. This source code is uploaded by the `defang` CLI to a storage destination in your cloud account. The Defang `CD` service will then retrieve it and determine if each of your service's images need to be rebuilt. If rebuilding is necessary, `CD` will start a new container for each build it needs to complete.
6363

64-
When you deploy an update to an existing service, the Defang `cd` service will determine if rebuilding your service's images is necessary. For example, when deploying new source code, `cd` will request that a new image be built. When deploying an update which does not require a new image, one will not be built—for example, redeploying the same service with increased or decreased resource requirements. In this case, the same image can be deployed to newly provisioned cloud resources.
64+
When you deploy an update to an existing service, the Defang `CD` service will determine if rebuilding your service's images is necessary. For example, when deploying new source code, `CD` will request that a new image be built. When deploying an update which does not require a new image, one will not be built—for example, redeploying the same service with increased or decreased resource requirements. In this case, the same image can be deployed to newly provisioned cloud resources.
6565

6666
Defang uses [Kaniko](https://github.com/GoogleContainerTools/kaniko) to build your images in a container in your cloud account. The resulting images will be stored in your cloud account's private container registry for future reference.
6767

6868

6969
## Service Provisioning
7070

71-
After your images have been built, `cd` will provision the necessary resources and deploy these images as new services in your cloud account. Defang uses the cloud provider's SDK to create the necessary resources for your services. This may include creating new containers, setting up networking, and configuring any other resources your services needs, such as storage resources.
71+
After your images have been built, `CD` will provision the necessary resources and deploy these images as new services in your cloud account. Defang uses the cloud provider's SDK to create the necessary resources for your services. This may include creating new containers, setting up networking, and configuring any other resources your services needs, such as storage resources.
7272

73-
When deploying changes to existing services, the `cd` service will determine the minimum set of changes necessary and add, remove, replace, or update services as necessary.
73+
When deploying changes to existing services, the `CD` service will determine the minimum set of changes necessary and add, remove, replace, or update services as necessary.

0 commit comments

Comments
 (0)