Skip to content

Docs Updates #106

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 2 commits into from
Oct 17, 2024
Merged

Docs Updates #106

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6739b88
update debug and byoc
raphaeltm Oct 16, 2024
9975e15
add more specifics about deployment failures
raphaeltm Oct 17, 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
12 changes: 12 additions & 0 deletions docs/concepts/debug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,16 @@ Defang includes an AI-driven tool to help you debug your cloud applications. The

:::warning
The AI debugging assistant is currently in preview and is currently limited in its capabilities. We plan to expand the capabilities of the AI assistant in the future.
:::

## How it works

When you deploy a service to the [Defang Playground](./defang-playground.md), the Defang CLI will wait for the service's status to switch to healthy. If the service fails to deploy, the AI debugger will kick in. It will analyze the logs and files in your project to identify the issue and provide you with a suggested fix.

:::warning
The AI debugger currently only works in Playground.
:::

:::info
The AI debugger only kicks in when the service fails to deploy. At the moment, we do not offer any way to trigger the AI debugger manually.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this true? Doesn't it kick in if the Deploy succeeds but healthcheck fails?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What you're describing is what I would call a failed deployment.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also, I just double checked with @lionello and it gets triggered for other deployment failures as well: "anything except compose syntax errors"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Prakash-Sundaresan I updated with more details about different potential failure cases.

:::
5 changes: 4 additions & 1 deletion docs/concepts/defang-byoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,12 @@ Please read the [AWS Provider](../providers/aws/aws.md) documentation for more d
## DigitalOcean

:::info
The Private Beta of the Defang BYOC DigitalOcean Provider will be released in September 2024. Its development is tracked [here](https://github.com/DefangLabs/defang/pull/594).

The Public Preview of the v1 Defang BYOC DigitalOcean Provider as of October 1 2024.
:::

Please read the [DigitalOcean Provider](../providers/digitalocean/digitalocean.md) documentation for more details about how the DigitalOcean provider works and how to get started.

## Azure

:::info
Expand Down
Loading