Skip to content

[UI] Updated Backend config Info section #2125

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
olgenn merged 1 commit into from
Dec 21, 2024
Merged

[UI] Updated Backend config Info section #2125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions contributing/FRONTEND.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ For frontend development, run a `webpack` dev server:
npm run start
```

The `webpack` dev server expects the API to be running on `http://127.0.0.1:3001`. So ensure to run the API on port `3001`:
The `webpack` dev server expects the API to be running on `http://127.0.0.1:8000`. So ensure to run the API on port `8000`:

```shell
dstack server --port 3001
dstack server --port 8000
```
48 changes: 35 additions & 13 deletions frontend/src/pages/Project/Backends/YAMLForm/constants.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,67 @@
import React from 'react';

export const CONFIG_YAML_HELP_SKY = {
header: <h2>SKy Backend config</h2>,
header: <h2>Backend config</h2>,
body: (
<>
<p>
The backend config is defined in the <code>YAML</code> format. It specifies the backend's <code>type</code> and
settings, such as <code>creds</code>, <code>regions</code>, and so on.
The backend config is defined in the YAML format. It specifies the backend's <code>type</code> and settings,{' '}
such as <code>creds</code>, <code>regions</code>, and so on.
</p>
<h4>Marketplace</h4>
<p>
If you set <code>creds</code>'s <code>type</code> to <code>dstack</code>, you'll get compute from{' '}
<code>dstack</code>'s marketplace and will pay for it via your <code>dstack Sky</code> user billing. Example:
</p>
<p>Example:</p>
<p>
<pre>
type: aws{'\n'}
creds:{'\n'}
{' '}type: default{'\n'}
{' '}access_key: AIZKISCVKUK{'\n'}
{' '}secret_key: QSbmpqJIUBn1
{' '}type: dstack{'\n'}
</pre>
</p>
<p>
Each backend type may support different properties. See the{' '}
<a href={'https://dstack.ai/docs/reference/server/config.yml/#examples'}>reference page</a> for more examples.
You can see all supported backend types at the{' '}
<a href={'https://dstack.ai/docs/reference/server/config.yml/#examples'} target={'_blank'}>
documentation
</a>
.
</p>
<h4>Your own cloud account</h4>
<p>
If you want to use your own cloud account, configure <code>creds</code> and other settings according to the{' '}
<a href={'https://dstack.ai/docs/reference/server/config.yml/#examples'} target={'_blank'}>
documentation
</a>
. Example:
</p>
<p>
<pre>
type: aws{'\n'}
creds:{'\n'}
{' '}type: access_key{'\n'}
{' '}access_key: AIZKISCVKUK{'\n'}
{' '}secret_key: QSbmpqJIUBn1
</pre>
</p>
</>
),
};

export const CONFIG_YAML_HELP_ENTERPRISE = {
header: <h2>Enterprise Backend config</h2>,
header: <h2>Backend config</h2>,
body: (
<>
<p>
The backend config is defined in the <code>YAML</code> format. It specifies the backend's <code>type</code> and
settings, such as <code>creds</code>, <code>regions</code>, and so on.
The backend config is defined in the YAML format. It specifies the backend's <code>type</code> and settings,
such as <code>creds</code>, <code>regions</code>, and so on.
</p>
<p>Example:</p>
<p>
<pre>
type: aws{'\n'}
creds:{'\n'}
{' '}type: default{'\n'}
{' '}type: access_key{'\n'}
{' '}access_key: AIZKISCVKUK{'\n'}
{' '}secret_key: QSbmpqJIUBn1
</pre>
Expand Down