-
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 1 commit
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,54 @@ | ||
--- | ||
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 and provides a streamlined experience to develop, deploy, and debug your cloud applications. | ||
|
||
jordanstephens marked this conversation as resolved.
Show resolved
Hide resolved
|
||
```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
|
||
## Defang CD | ||
jordanstephens marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
The first time you deploy with Defang, we will create a new `cd` service in your cloud account. This service acts as an intermediary between you and your cloud provider. The Defang CLI will communicate with this service to orchestrate the build and deployment process for your services. | ||
jordanstephens marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
:::info | ||
This 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. | ||
jordanstephens marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
::: | ||
|
||
## Image Builds | ||
jordanstephens marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
When you deploy a new service, Defang will build a Docker image from your source code. `cd` will determine if your service's image needs to be rebuilt, and if it does it will start a new container for each build it needs to complete. Defang uses [Kaniko](https://github.com/GoogleContainerTools/kaniko/actions/workflows/images.yaml) 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. Defang will then deploy this image to your cloud account as a new service. | ||
jordanstephens marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Service Provisioning | ||
|
||
Once your service's image has been built, Defang will provision cloud resources for your application's services. Defang uses the cloud provider's SDK to create the necessary resources for your services. This includes creating a new container, setting up networking, and configuring any other resources your service needs. | ||
jordanstephens marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
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.