Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion docs/concepts/accounts.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Accounts
description: How accounts are organized in Defang.
sidebar_position: 100
---

# Accounts
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/authentication.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
sidebar_position: 200
title: Authentication
description: Authenticating with Defang.
---
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/compose.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Compose
description: Defang allows you to use the compose.yaml specification to deploy your application to the cloud.
sidebar_position: 150
---

# Compose
Expand Down
3 changes: 1 addition & 2 deletions docs/concepts/configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Configuration
description: Configuring your Defang application, including sensitive config values like API keys, passwords, and other credentials.
sidebar_position: 225
---

# Configuration
Expand Down Expand Up @@ -67,7 +66,7 @@ In the example above, if we assume the value of the configuration variable ***US

During `defang compose up` all variable references will be replaced with the actual value and made available in the container. If any referenced variable is not found the `defang compose up` command will be canceled.

## Using Config with Pulumi
## Using Config with Pulumi
In Defang, using config with [Pulumi](./pulumi.md) gives you the advantage of being able to manage your environment variables across different environments using Pulumi stacks.

:::tip
Expand Down
9 changes: 4 additions & 5 deletions docs/concepts/debug.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Debug
description: Defang uses AI to help you debug your cloud applications.
sidebar_position: 650
---

# Debug
Expand All @@ -16,20 +15,20 @@ Defang has another AI-driven tool called [`generate`](/docs/concepts/generate).

Here is a typical workflow in the [Defang CLI](/docs/getting-started) that will automatically run the AI debugger tool:

1. When you deploy a project with Defang (i.e. `defang compose up`), the CLI will wait for all services' statuses to switch to healthy.
1. When you deploy a project with Defang (i.e. `defang compose up`), the CLI will wait for all services' statuses to switch to healthy.

2. If any service fails to deploy, the AI debugger will kick in and ask for permission.

3. The AI agent will analyze the logs and files in your project to identify the issue(s).

4. Then, it will provide you with the suggested fix(es) in the terminal.
4. Then, it will provide you with the suggested fix(es) in the terminal.

:::tip
The AI debugger will not change your files. Instead, it will show you a suggestion, and it is up to you if you want to use it in your code.
:::

The AI debugger only kicks in when any service in a project fails to deploy. This could be because of a build failure, healthchecks failing, or a variety of other issues.
The AI debugger only kicks in when any service in a project fails to deploy. This could be because of a build failure, healthchecks failing, or a variety of other issues.

:::info
The AI debugger only kicks in when any service in a project fails to deploy. At the moment, we do not offer any way to trigger the AI debugger manually.
The AI debugger only kicks in when any service in a project fails to deploy. At the moment, we do not offer any way to trigger the AI debugger manually.
:::
1 change: 0 additions & 1 deletion docs/concepts/defang-byoc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Defang BYOC
description: Defang allows you deploy services, defined as containers, to your own cloud accounts.
sidebar_position: 50
---

# Defang BYOC
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/defang-playground.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Defang Playground
description: Defang Playground allows you to get a feel for how Defang works without running production workloads in your own cloud accounts.
sidebar_position: 00
---

# Defang Playground
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/deployment-modes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Deployment Modes
description: Defang provides three deployment modes which allow you to balance cost and resiliency.
sidebar_position: 501
---

# Deployment Modes
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/deployments.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Deployment
description: Defang will build your services in the cloud and manage the deployment process for you.
sidebar_position: 500
---

# Deployment
Expand Down
13 changes: 6 additions & 7 deletions docs/concepts/domains.mdx
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
---
title: Domains
title: Domains
description: Defang helps you provision SSL certificates and expose your services to the internet.
sidebar_position: 280
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Domains

Defang helps you provision SSL certificates and expose your services to the internet. You can expose your services using Defang-hosted domains or bring your own custom domain with [Defang BYOC](./defang-byoc.md). This page explains how to configure your services to be accessible from the public internet.
Defang helps you provision SSL certificates and expose your services to the internet. You can expose your services using Defang-hosted domains or bring your own custom domain with [Defang BYOC](./defang-byoc.md). This page explains how to configure your services to be accessible from the public internet.

## Defang-hosted Domains

To make your service accessible from the public internet with Defang-hosted domains (under `defang.app`), you simply expose ports in your service definition.
To make your service accessible from the public internet with Defang-hosted domains (under `defang.app`), you simply expose ports in your service definition.

### Structure

Defang-hosted domains use a structure that is based on your username and service name.
Defang-hosted domains use a structure that is based on your username and service name.

<Tabs>
<TabItem value="playground" label="Playground" default>
Expand Down Expand Up @@ -46,7 +45,7 @@ services:
ports:
// highlight-start
- mode: ingress
target: 3000
target: 3000
protocol: http
// highlight-end
```
Expand Down Expand Up @@ -103,7 +102,7 @@ services:
ports:
// highlight-start
- mode: ingress
target: 3000
target: 3000
protocol: http
// highlight-end
```
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/estimation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Cost Estimation
description: Defang enables you to estimate the cost of deploying and running your project before you even create a cloud account.
sidebar_position: 280
---

# Cost Estimation
Expand Down
3 changes: 1 addition & 2 deletions docs/concepts/generate.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Generate
description: Defang uses AI to help you generate a starting point for your cloud applications.
sidebar_position: 100
---

# Generate
Expand Down Expand Up @@ -46,4 +45,4 @@ An HTTP GET endpoint that returns an HTML with a random meme from the imgflip AP

```
A service that uses bullmq and redis. The compose file should also include a redis service. The code should set up a queue. It should also expose three endpoints with express: one to add a job to the queue, another to check how many tasks are in the queue, and a last one that runs on / which is just a healthcheck. The code should also include a worker that processes the queue by logging what's in each task. Use environment variables to configure the redis connection. No password.
```
```
1 change: 0 additions & 1 deletion docs/concepts/managed-llms/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{
"label": "Managed LLMs",
"position": 425,
"collapsible": true
}
1 change: 0 additions & 1 deletion docs/concepts/managed-llms/managed-language-models.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Using Managed LLMs
description: Defang makes it easy to leverage cloud-native managed language models.
sidebar_position: 3000
---

# Managed Language Models
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/managed-llms/openai-access-gateway.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: OpenAI Access Gateway
description: Defang makes it easy to leverage cloud-native managed language models for your OpenAI-compatible application.
sidebar_position: 3000
---

# OpenAI Access Gateway
Expand Down
3 changes: 1 addition & 2 deletions docs/concepts/managed-storage/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{
"label": "Managed Storage",
"position": 450,
"collapsible": true
}
}
1 change: 0 additions & 1 deletion docs/concepts/managed-storage/managed-mongodb.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Managed MongoDB
description: Defang can help you provision managed MongoDB instances.
sidebar_position: 3000
---

# Managed MongoDB
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/managed-storage/managed-object-storage.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Managed Object Storage
description: Defang can help you provision managed Redis instances.
sidebar_position: 3000
---

# Managed Object Storage
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/managed-storage/managed-postgres.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Managed Postgres
description: Defang can help you provision managed Postgres.
sidebar_position: 1000
---

# Managed Postgres
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/managed-storage/managed-redis.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Managed Redis
description: Defang can help you provision managed Redis instances.
sidebar_position: 2000
---

# Managed Redis
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/managed-storage/managed-storage.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Managed Storage
description: Defang can help you provision managed storage services.
sidebar_position: 000
---

# Managed Storage
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/networking.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Networking
description: Defang helps you safely configure your services' networking.
sidebar_position: 300
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
3 changes: 1 addition & 2 deletions docs/concepts/observability.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Observability
description: Monitor and debug your Defang services with the Defang CLI and Portal.
sidebar_position: 600
---

# Observability
Expand All @@ -11,7 +10,7 @@ You can easily monitor and debug your Defang services at build and runtime using
When you deploy a service using the `defang compose up`, the CLI will automatically start tailing the build and runtime logs for your service. You can also view the logs for your service in the Portal, or by using the `defang tail` command.

:::tip
Defang has a tutorial on how you can [monitor your services' status and logs](/docs/tutorials/monitoring-your-services).
Defang has a tutorial on how you can [monitor your services' status and logs](/docs/tutorials/monitoring-your-services).
:::

:::warning
Expand Down
3 changes: 1 addition & 2 deletions docs/concepts/portal.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Portal
description: You can log into the Defang Portal to view the state of your Defang services.
sidebar_position: 700
---

# Portal
Expand All @@ -11,7 +10,7 @@ You can log into the Defang Portal at [portal.defang.dev](https://portal.defang.
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 Defang 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).
:::

Expand Down
1 change: 0 additions & 1 deletion docs/concepts/projects.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Projects
description: A _project_ refers to a cohesive collection of services which are defined and managed using a `compose.yml` file.
sidebar_position: 200
---

# Projects
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/pulumi.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Pulumi
description: Define your Defang services with Pulumi to integrate with other cloud resources.
sidebar_position: 175
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/railpack.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Railpack
description: Defang will use Railpack to make an OCI-Compliant container image for your project.
sidebar_position: 500
---

# Railpack
Expand Down
1 change: 0 additions & 1 deletion docs/concepts/resources.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Resources
description: Customize the resources your Defang services use.
sidebar_position: 350
---

# Run-time Resources
Expand Down
7 changes: 3 additions & 4 deletions docs/concepts/scaling.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Scaling
description: Defang can help you handle service irregular loads.
sidebar_position: 375
---

# Scaling
Expand Down Expand Up @@ -47,10 +46,10 @@ With Defang, users on the Pro plan or higher can enable service-level autoscalin
services:
service-example:
x-defang-autoscaling: true #enable autoscaling for this service
build:
build:
context: .
dockerfile: Dockerfile
ports:
ports:
- mode: ingress
target: 8080
published: 8080
Expand Down Expand Up @@ -84,5 +83,5 @@ Auto-scaling systems typically rely on:

- Ensure services are **stateless** or use **externalized state** (e.g., databases, caches) for smooth scaling. ([12 Factor App](https://12factor.net/processes))
- Test services under load to identify scaling bottlenecks.

See Tutorial page [Scaling Tutorial](/docs/tutorials/scaling-your-services)
7 changes: 3 additions & 4 deletions docs/concepts/security.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Security
title: Security
description: Defang configures your cloud applications and services with security best practices.
sidebar_position: 275
---

# Security
Expand All @@ -20,12 +19,12 @@ Defang creates roles for your services to use, and attaches policies to those ro

## Networking

Defang configures Security Groups, deploys applictions to a private subnet and uses an Application Load Balancer to route traffic to your services from the public internet only when required.
Defang configures Security Groups, deploys applictions to a private subnet and uses an Application Load Balancer to route traffic to your services from the public internet only when required.

## SSL

Defang automates the process of obtaining and renewing SSL certificates for your services using AWS Certificate Manager.

## Secrets

Secrets are stored in AWS Systems Manager Parameter Store, and are encrypted using a key stored in AWS Key Management Service (KMS).
Secrets are stored in AWS Systems Manager Parameter Store, and are encrypted using a key stored in AWS Key Management Service (KMS).
Loading