diff --git a/docs/concepts/accounts.md b/docs/concepts/accounts.md index 6e2dd5a83..b2c5db391 100644 --- a/docs/concepts/accounts.md +++ b/docs/concepts/accounts.md @@ -6,32 +6,26 @@ sidebar_position: 100 # Accounts -In this section, we'll be talking about a couple different topics related to accounts in Defang. First we'll cover authentication and how to create an account, and then we'll talk about how resources are organized within a cloud environment using your account info. +Below, we will cover account creation with Defang, and how resources are organized within a cloud environment using your account info. -:::tip Why do I need an account? -Defang requires an account so we can organize your resources and provide you with a way to manage them. We also use your account to authenticate you when you interact with [Defang Playground](./defang-playground.md) and the [Defang Portal](./portal.md). - -Eventually, billing and payment information will be associated with your account. -::: +Defang requires an account so we can organize your resources and provide you with a way to manage them. We also use your account to authenticate you when you interact with [Defang Playground](./defang-playground.md) and the [Defang Portal](./portal.md). Billing and payment information is also associated with your account. ## Creating an Account -To create an account, login to Defang and accept the [terms of service](https://defang.io/terms-service.html) using the [CLI](/docs/concepts/authentication.md). +To create an account, log in to Defang and accept the [Terms of Service](https://defang.io/policies/terms-service/) using the [CLI](/docs/concepts/authentication.md). + +At the moment, the only way to authenticate with Defang is through GitHub. We plan to offer other [authentication](/docs/concepts/authentication.md) providers in the future. -At the moment, the only way to authenticate with Defang is through GitHub. We plan to offer other authentication providers in the future. +:::tip +Keep in mind that your Defang account is separate from your [cloud provider account](./defang-byoc.md). You will need to authenticate with your cloud provider account separately to deploy services to your own cloud account. +::: ## Structure -Your GitHub username will be used as your Defang username and your Defang username is used to group all your services and to generate domains for your services with the following structure: +Your GitHub username will be used as your Defang username. Your Defang username is used to group all your [services](/docs/concepts/services) and generate domains for your services with the following structure: ``` ---.prod1.defang.dev ``` -:::warning -Keep in mind that your Defang account is separate from your [cloud provider account](./defang-byoc.md). You will need to authenticate with your cloud provider account separately to deploy services to your own cloud account. -::: - -:::info -We plan to introduce a more robust system for managing accounts, permissions, service groups, etc. in the future. -::: +For more about domain structures, see our [Domains](/docs/concepts/domains#structure) page. diff --git a/docs/concepts/authentication.md b/docs/concepts/authentication.md index 4f6cf4e7f..e9ae72850 100644 --- a/docs/concepts/authentication.md +++ b/docs/concepts/authentication.md @@ -6,14 +6,14 @@ description: Authenticating with Defang. # Authentication -To do pretty much anything with Defang, you'll need to authenticate with the system. You can do this by running the following command: +To do pretty much anything with Defang, you'll need to authenticate with the system. You can do this by running the following command in the [CLI](/docs/getting-started): ```bash defang login ``` -This will prompt you to open a browser and log into your Defang account. For now, the only way to login is with GitHub, though we will offer other providers to authenticate in the future. Once you've logged in, you can close the browser and return to the terminal. You should see a message that you've successfully logged in. +This will prompt you to open a browser and log in to your [Defang account](/docs/concepts/accounts). For now, the only way to log in is with GitHub, though we will offer other providers to authenticate in the future. Once you've logged in, you can close the browser and return to the terminal. You should see a message that you've successfully logged in. -:::warning +:::tip Keep in mind that your Defang account is separate from your [cloud provider account](/docs/concepts/defang-byoc). You will need to authenticate with your cloud provider account separately to deploy services to your own cloud account. ::: diff --git a/docs/concepts/deployments.md b/docs/concepts/deployments.md index e195d2886..bc07c59f5 100644 --- a/docs/concepts/deployments.md +++ b/docs/concepts/deployments.md @@ -10,12 +10,22 @@ When you deploy using Defang, whether it's with `defang compose up` with a [Comp ## Deploying Updates -When you run a deployment to update one or more services, Defang will also make sure to get your new services up and running before deprovisioning any old services so you don't have to worry about downtime. +When you run a deployment to update one or more [services](/docs/concepts/services), Defang will build new images for your services, and provision new resources to replace your existing services. + +### Zero Downtime Deployments + +Defang can deploy your services using different [modes](/docs/concepts/deployment-modes). When using the `production` mode, Defang will make sure the new replacement services are healthy before deprovisioning your existing services. + +By default, using the `development` mode, Defang will deprovision your existing services before provisioning replacements. This helps reduce costs. :::info -In [Defang BYOC](./defang-byoc.md), Defang will use your cloud provider account to build and store your images. In [Defang Playground](./defang-playground.md) we will build and store your images for you. +In [Defang BYOC](./defang-byoc.md), Defang uses your cloud provider account to build and store your images. In [Defang Playground](./defang-playground.md), we build and store your images for you. ::: + +### Deployment Modes + +As mentioned above, Defang offers different [deployment modes](/docs/concepts/deployment-modes): `development`, `staging`, and `production`. You can switch the modes using the `--mode` CLI flag. :::warning Workloads with GPUs do not support zero downtime deployments. If you have a workload with a GPU, you will experience downtime during updates. ::: @@ -26,4 +36,4 @@ Defang defaults to "spot" instances. This is a cost-effective way to run your wo :::info In the future, we may provide a way to use "on-demand" instances for workloads that require more stability. -::: \ No newline at end of file +::: diff --git a/docs/concepts/domains.mdx b/docs/concepts/domains.mdx index 280c242d2..45204af08 100644 --- a/docs/concepts/domains.mdx +++ b/docs/concepts/domains.mdx @@ -30,7 +30,7 @@ https://---.defang.dev If you're using [Defang BYOC](./defang-byoc.md), your domain will be: ``` -https://--.username.defang.app +https://--..defang.app ``` @@ -114,4 +114,3 @@ As of now, the Pulumi provider does not support [Defang BYOC](./defang-byoc.md) ::: - diff --git a/docs/concepts/managed-storage/managed-postgres.md b/docs/concepts/managed-storage/managed-postgres.md index e995a0e1d..83ae20908 100644 --- a/docs/concepts/managed-storage/managed-postgres.md +++ b/docs/concepts/managed-storage/managed-postgres.md @@ -6,7 +6,7 @@ sidebar_position: 1000 # Managed Postgres -Postgres, or PostgreSQL, is an advanced open-source relational database system known for its robustness, extensibility, and compliance with SQL standards, making it a popular choice for complex applications requiring reliable data integrity and sophisticated querying capabilities. +Postgres, or PostgreSQL, is a powerful open-source relational database system known for its robustness, extensibility, and compliance with SQL standards, making it ideal for complex applications requiring reliable data integrity and advanced querying. Defang can help you provision a managed Postgres instance. ## Current Support @@ -75,13 +75,13 @@ For a smoother experience with Defang, we recommend using Postgres 14 for your c ## Final Snapshots -When a project is deployed to a production environment any managed postgres instances are automatically configured to create a snapshot of the database before deletion. The snapshot will be named with the following format +When a project is deployed to a [production environment](/docs/concepts/deployment-modes), any managed Postgres instances are automatically configured to create a snapshot of the database before deletion. The snapshot will be named with the following format: ` --postgres--final-snapshot ` -The AWS Console can be used to restore a snapshop into a new instance of postgres. +The AWS Console can be used to restore a snapshot into a new instance of Postgres.