Skip to content
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

Jump to bottom

add information about grid edit cluster #301

Merged
merged 1 commit into from
Jul 12, 2022
Merged

add information about grid edit cluster #301

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
40 changes: 39 additions & 1 deletion docs/platform/2_Custom Cloud Credentials/3_adding-custom-cloud-credentials.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,14 +298,52 @@ Or if you're using config file set the `.compute.provider.cluster` field to the

Your cluster will be available for use on Grid, so use it \(or any other cluster\) as you wish.

## Editing and Deleting Clusters
## Editing Clusters

Use `grid edit` to see instance types available and update as necessary.

```bash
grid edit cluster <cluster name>
```

An editor in your command line will show the json configuration for the Cluster like the one below (we have omitted with ellipsis `...` some attributes to make this section easier to understand)
```
{
"cluster_type": "CLUSTER_TYPE_BYOC",
"cost_factor": "",
"desired_state": "CLUSTER_STATE_RUNNING",
"driver": {
"external": null,
"kubernetes": {
"aws": {
...
"instance_types": [
{
"name": "g4dn.xlarge",
"overprovisioned_ondemand_count": 0,
},
{
"name": "m5ad.xlarge",
"overprovisioned_ondemand_count": 0,
},
],
...
},
...
},
},
...
"performance_profile": "CLUSTER_PERFORMANCE_PROFILE_DEFAULT"
}
```
Some important attributes you can chagne:
- __instance_types__: Here you can add or remove Instance Type following AWS naming, but at the moment only instances that are amd64 compatible can be used. You can also change the `overprovisioned_ondemand_count` for the instance if you want to pre-allocate instances for faster start but that will also make you incur in extra costs.
- __performance_profile__: You can change the profile for the cluster. It can either be
- `CLUSTER_PERFORMANCE_PROFILE_DEFAULT` with extra nodes for larger clusters and metrics and monitoring capabilities
- `CLUSTER_PERFORMANCE_PROFILE_COST_SAVING` for smaller clusters but also without metrics and monitoring capabilities but also less expensive to run.

## Deleting Clusters

Use `grid delete` to delete cluster. Deleting a cluster will delete its resources, including runing resources. The deletion will take ~20-30 minutes. Use with care! The flag `--wait` is also available here, in the case of using, grid CLI will wait until the cluster is deleted.

:::note
Expand Down