Skip to content

More docs fixes #155

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.

Sign up for GitHub

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 10 commits into from
Dec 31, 2024
Merged

More docs fixes #155

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6190b11
slightly restructuring accounts/auth pages
commit111 Dec 27, 2024
6f2603e
add more links to deployments page
commit111 Dec 27, 2024
3c7dd18
reword the managed services pages to be more consistent
commit111 Dec 27, 2024
10d8c01
reword pages for clarity
commit111 Dec 27, 2024
471bc28
minor fix to domains page
commit111 Dec 27, 2024
dbb2a41
Update line about billing
raphaeltm Dec 30, 2024
5de2e5d
Apply suggestions from code review
commit111 Dec 30, 2024
5e8b53c
changes to observability
commit111 Dec 31, 2024
31d294e
Merge branch 'linda-docs-8' of https://github.com/DefangLabs/defang-d…
commit111 Dec 31, 2024
5a041d7
capitalize page names
commit111 Dec 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 10 additions & 14 deletions docs/concepts/accounts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,28 @@ 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).
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@commit111 I think we can also remove this line, because billing is now associated with an account.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@commit111 I've updated that line. Let me know what you think and we can merge this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! LGTM

:::

## 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:

```
<username>-<servicename>--<port>.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.
6 changes: 3 additions & 3 deletions docs/concepts/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
8 changes: 5 additions & 3 deletions docs/concepts/deployments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ 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 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.

:::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.
:::

Note that we offer different [deployment modes](/docs/concepts/deployment-modes): development, staging, and production. You can switch the modes using the CLI.

:::warning
Workloads with GPUs do not support zero downtime deployments. If you have a workload with a GPU, you will experience downtime during updates.
:::
Expand All @@ -26,4 +28,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.
:::
:::
3 changes: 1 addition & 2 deletions docs/concepts/domains.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ https://<username>-<service-name>--<port>.defang.dev
If you're using [Defang BYOC](./defang-byoc.md), your domain will be:

```
https://<service-name>--<port>.username.defang.app
https://<service-name>--<port>.<username>.defang.app
```
</TabItem>
</Tabs>
Expand Down Expand Up @@ -114,4 +114,3 @@ As of now, the Pulumi provider does not support [Defang BYOC](./defang-byoc.md)
:::
</TabItem>
</Tabs>

6 changes: 3 additions & 3 deletions docs/concepts/managed-storage/managed-postgres.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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:

`
<project-name>-<service>-postgres-<id>-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.

<!--
### Major Version Updating of Engine
Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/managed-storage/managed-redis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ cache:
## Final Snapshots
When a project is deployed with the `production` [deployment mode](/docs/concepts/deployment-modes) any managed redis instances are automatically
configured to create a snapshot of the datastore before deletion. The snapshot will be named with the following format
When a project is deployed with the `production` [deployment mode](/docs/concepts/deployment-modes), any managed Redis instances are automatically
configured to create a snapshot of the datastore before deletion. The snapshot will be named with the following format:

`
<project-name>-<service>-redis-<id>-final-snapshot
`

The AWS Console can be used to restore a snapshop into a new instance of redis.
The AWS Console can be used to restore a snapshot into a new instance of Redis.
9 changes: 4 additions & 5 deletions docs/concepts/portal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,13 @@ sidebar_position: 700

You can log into the Defang Portal at [portal.defang.dev](https://portal.defang.dev) using your [Defang account](./accounts.md) to view the state of your Defang services running in the Defang Playground for non-production applications.

You can use the Portal to get an overview of your services, view the logs for each service, quickly access exposed ports, view environment variables, and more.

You can use the Portal to get an overview of your [services](/docs/concepts/services), view the logs for each service, quickly access exposed ports, view environment variables, and more.

:::info
The Defang Portal displays services deployed to Playground.
The Defang Portal displays services deployed to Defang Playground.
To view services deployed to Defang BYOC, please check out [Monitoring Your Services](/docs/tutorials/monitoring-your-services).
:::

:::tip
We have a tool in place to help [debug](/docs/concepts/debug) your application in production.
:::
Need help with a failing deployment? Defang provides a tool to help [debug](/docs/concepts/debug) in your application.
:::
8 changes: 4 additions & 4 deletions docs/concepts/services.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ Defang allows you deploy services defined as containers. You can define your ser

`<username>-<service-name>`

You can learn more about accounts and usernames in the [accounts page](./accounts.md).
You can learn more about accounts and usernames in the [Accounts page](./accounts.md).

:::tip Service Names
:::tip
Service names are defined in your Compose file or your Pulumi program.
:::

You can learn more about about how to define [services with Compose files here](./compose.md) and [services with Pulumi here](./pulumi.md). You can learn more about how services are deployed in the [deployment page](./deployments.md).
Defang manages the deployment process for services. You can learn more about how services are deployed in the [Deployment page](./deployments.md).

:::info
While this is the current state of the Defang model, we plan to add support for other types of services in the future, including serverless functions.
We plan to add support for other types of services in the future, including serverless functions.
:::
Loading