-
Notifications
You must be signed in to change notification settings - Fork 6
High level overview doc "How it works" #149
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
302d6b6
rough cut
jordanstephens c2a11b7
Update docs/intro/how-it-works.mdx
jordanstephens 198514e
Apply suggestions from code review
jordanstephens ae756a8
Apply suggestions from code review
jordanstephens 27d9732
Clarify that source code is never uploaded to defang's servers.
jordanstephens 1ae3a13
Update docs/intro/how-it-works.mdx
Prakash-Sundaresan a177aab
Update docs/intro/how-it-works.mdx
Prakash-Sundaresan 3816688
Update docs/intro/how-it-works.mdx
Prakash-Sundaresan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 @@ | ||
--- | ||
sidebar_position: 250 | ||
title: How it Works | ||
description: Overview of the Defang platform and how it works in your cloud | ||
--- | ||
|
||
# How Defang Works | ||
|
||
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. | ||
|
||
## Bootstrapping | ||
|
||
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. | ||
|
||
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. | ||
|
||
You can learn more about the specifics by visiting our [provider docs](/docs/category/providers). | ||
|
||
:::info | ||
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. | ||
::: | ||
|
||
```mermaid | ||
|
||
flowchart TD | ||
subgraph workspace["Local Workspace"] | ||
compose[compose.yaml] | ||
cli("Defang CLI") | ||
end | ||
|
||
subgraph cloud["Cloud"] | ||
sdk(("SDK")) | ||
cd(cd) | ||
kaniko(Kaniko) | ||
|
||
subgraph services[" "] | ||
service1("Service 1") | ||
service2("Service 2") | ||
service3("Service 3") | ||
end | ||
end | ||
|
||
compose --> cli | ||
|
||
cli <--> cd | ||
cd --> kaniko | ||
cd --> sdk | ||
sdk --> services | ||
|
||
``` | ||
|
||
jordanstephens marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## Orchestrating Deployments | ||
|
||
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. | ||
|
||
:::info | ||
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. | ||
::: | ||
|
||
## Building Images | ||
|
||
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. | ||
Prakash-Sundaresan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. | ||
|
||
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. | ||
|
||
|
||
## Service Provisioning | ||
|
||
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. | ||
Prakash-Sundaresan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.