From b688ca3bdb466cbe746ee0e82f931e873f5dc916 Mon Sep 17 00:00:00 2001 From: Bryan Ward Date: Thu, 13 Aug 2026 08:59:15 -0700 Subject: [PATCH] docs: site-wide accuracy, consistency, and structural fixes Tier 1 (ship-blockers): - Fix malformed shell commands in LMX server-setup (uvx v8x pasted as values) - Fix wrong support email domain (vantage.com -> vantagecompute.ai) - Fix broken self-links on licenses index and inventory pages - Fix FlexLM port (6200 -> 27000) and placeholder domains - Fix RLM web_port typo (4954 -> 5054) - Fix wrong API domain in endpoints reference (vantage.ai -> vantagecompute.ai) Tier 2 (contradictions): - Standardize CLI provider flag to on_prem across all localhost pages - Fix CLI from-source command (uvx v8x -> uv run v8x) - Standardize "preview" label (was "early access" on some pages) - Reconcile sweeps preset UI vs API-only contradiction - Add Abaqus legacy note on FlexLM page (current versions use DSLS) Tier 3 (structure): - Create LS-DYNA server-setup overview page and sidebar entry - Create support index page linking ticket guides - Fix storage index title and add missing mounting guide links - Add next-steps sections to 5 jobs pages that ended abruptly - Add how-to cross-links on reference pages with procedural content - Add presets disambiguation notes, sweeps/trials cross-links - Add duplicate-content cross-reference on templates/using page Tier 4 (content accuracy): - Fix provider count (six -> five) - Fix changelog stub with GitHub releases link - Fix hardcoded NIM model count (277 -> "hundreds of") - Fix K8s -> Kubernetes in prose, Slurm+Kubernetes -> Slurm and Kubernetes - Fix mounting-in-endpoints outcome ordering - Fix observability hours-vs-dollars metric comparison - Clarify LS-DYNA duplicate exports and SMP settings - Update LSTC ownership (now part of Ansys) - Add TODO comments for items needing product confirmation Tier 5 (consistency/polish): - Fix 7 explanation page titles (generic "Concepts" -> specific names) - Prefix all license sub-page titles with product name - Fix sidebar labels: LM-X -> LMX, Olicense -> OLicense - Fix H1/nav mismatches (Quickstart -> Get started with X, etc.) - Fix status naming: "ready state" -> "Connected state" in storage guides - Standardize status casing across Kubernetes and Slurm reference - Fix singlenode -> single-node, comma splices, tutorial trailing period - Standardize Remote Desktop protocol naming - Expand acronyms on first use (SLA, PVC, DAG, OIDC, RBAC) - Fix glossary alphabetical order, add Slurm and Workbench entries - Add IAM roles vs permission groups disambiguation - Add vdeployer-web definition in CLI commands reference - Rename license tutorials page to FlexLM-specific Co-Authored-By: Claude Opus 4.6 --- docs/changelog.md | 9 ++------ docs/explanation/clusters.mdx | 2 +- docs/explanation/compute-providers.mdx | 4 ++-- .../concepts/jobs-and-pipelines.md | 8 +++---- docs/explanation/concepts/teams-and-iam.md | 10 ++++++++- .../explanation/concepts/why-teams-and-iam.md | 2 +- .../concepts/workbench-ml-stack.md | 4 ++-- docs/explanation/concepts/workspaces.md | 4 ++-- docs/explanation/federations.mdx | 4 ++-- docs/explanation/iam.mdx | 2 +- docs/explanation/jobs.mdx | 2 +- docs/explanation/licenses.mdx | 2 +- docs/explanation/storage.mdx | 4 ++-- docs/explanation/teams.mdx | 2 +- docs/explanation/workbench.mdx | 10 +++++++-- docs/glossary.md | 17 +++++++++----- .../catalog/deploy-nim-model.mdx | 2 +- docs/how-to-guides/catalog/get-started.mdx | 2 +- .../cloud-accounts/connect-cloud-account.mdx | 4 +++- docs/how-to-guides/clusters/get-started.mdx | 2 +- docs/how-to-guides/clusters/index.md | 6 ++--- .../clusters/kubernetes/create.mdx | 2 +- docs/how-to-guides/clusters/on-premises.mdx | 2 +- .../clusters/troubleshooting.mdx | 2 +- .../cli/deploy-slurm-local.mdx | 8 +++---- .../localhost/index.mdx | 4 ++-- docs/how-to-guides/iam/tutorials.mdx | 2 +- docs/how-to-guides/jobs/get-started.mdx | 2 +- docs/how-to-guides/jobs/scripts/creating.mdx | 10 +++++++++ docs/how-to-guides/jobs/scripts/managing.mdx | 10 +++++++++ .../jobs/submissions/monitoring.mdx | 10 +++++++++ .../how-to-guides/jobs/templates/creating.mdx | 10 +++++++++ .../how-to-guides/jobs/templates/managing.mdx | 12 +++++++++- docs/how-to-guides/jobs/templates/using.mdx | 4 +++- .../licenses/dsls/high-availability.md | 2 +- docs/how-to-guides/licenses/dsls/index.mdx | 2 +- .../how-to-guides/licenses/dsls/monitoring.md | 2 +- .../licenses/dsls/server-setup.mdx | 2 +- .../licenses/dsls/troubleshooting.md | 2 +- .../licenses/flexlm/high-availability.md | 2 +- docs/how-to-guides/licenses/flexlm/index.md | 2 +- .../licenses/flexlm/monitoring.md | 2 +- .../licenses/flexlm/server-setup.md | 22 +++++++++++-------- .../licenses/flexlm/troubleshooting.md | 4 ++-- .../flexlm/user-managed-server-setup.md | 2 ++ docs/how-to-guides/licenses/index.md | 2 +- docs/how-to-guides/licenses/inventory.mdx | 2 +- .../licenses/lmx/high-availability.md | 2 +- docs/how-to-guides/licenses/lmx/monitoring.md | 2 +- .../licenses/lmx/server-setup.md | 6 ++--- .../licenses/lmx/troubleshooting.md | 4 ++-- .../licenses/ls-dyna/high-availability.md | 2 +- docs/how-to-guides/licenses/ls-dyna/index.md | 4 ++-- .../licenses/ls-dyna/monitoring.md | 2 +- .../licenses/ls-dyna/server-setup.md | 15 +++++++++++++ .../licenses/ls-dyna/troubleshooting.md | 2 +- .../ls-dyna/user-managed-server-setup.md | 10 ++++++--- .../licenses/olicense/high-availability.md | 2 +- docs/how-to-guides/licenses/olicense/index.md | 4 +++- .../licenses/olicense/monitoring.md | 2 +- .../licenses/olicense/server-setup.md | 2 +- .../licenses/olicense/troubleshooting.md | 2 +- .../licenses/rlm/high-availability.md | 2 +- docs/how-to-guides/licenses/rlm/monitoring.md | 2 +- .../licenses/rlm/server-setup.md | 2 +- .../licenses/rlm/troubleshooting.md | 4 ++-- .../rlm/vantage-managed-server-setup.md | 2 +- docs/how-to-guides/licenses/tutorials.mdx | 8 +++++-- docs/how-to-guides/storage/cephfs.mdx | 2 +- docs/how-to-guides/storage/get-started.mdx | 5 ++++- docs/how-to-guides/storage/index.md | 8 +++++-- .../storage/mounting-in-endpoints.mdx | 4 ++-- .../storage/mounting-in-sessions.mdx | 2 +- docs/how-to-guides/storage/nfs.mdx | 2 +- docs/how-to-guides/support/index.md | 9 ++++++++ docs/how-to-guides/teams/tutorials.mdx | 2 +- .../how-to-guides/workbench/observability.mdx | 2 +- .../workbench/serve/canary-rollouts.mdx | 2 +- .../workbench/train/pipelines/creating.mdx | 2 +- .../workbench/troubleshooting.mdx | 2 +- docs/index.md | 2 +- docs/reference/clusters/kubernetes/manage.mdx | 12 ++++++++-- .../clusters/kubernetes/node-groups.mdx | 4 ++++ docs/reference/clusters/slurm/manage.mdx | 16 +++++++------- docs/reference/clusters/slurm/partitions.mdx | 4 ++++ .../developer-tools/cli/commands.mdx | 4 ++++ docs/reference/developer-tools/cli/index.md | 16 ++++++++------ docs/reference/licenses/reference.md | 2 ++ docs/reference/settings/iam/reference.md | 6 +++-- .../workbench/compute-profiles/reference.mdx | 2 ++ .../reference/workbench/endpoints/presets.mdx | 4 ++++ .../workbench/endpoints/reference.mdx | 4 +++- docs/reference/workbench/index.mdx | 1 + docs/reference/workbench/models/reference.mdx | 2 ++ docs/reference/workbench/pipelines/runs.mdx | 12 +++++++++- docs/reference/workbench/presets/index.mdx | 4 ++++ .../workbench/sessions/lifecycle.mdx | 4 +++- .../reference/workbench/sessions/notebooks.md | 2 ++ .../workbench/sessions/remote-desktops.md | 2 ++ docs/reference/workbench/sweeps/index.mdx | 4 ++++ docs/reference/workbench/sweeps/presets.mdx | 2 +- docs/reference/workbench/sweeps/trials.mdx | 6 ++++- .../workbench/training-jobs/lifecycle.mdx | 6 ++++- .../workbench/training-jobs/runtimes.mdx | 2 ++ docs/support.md | 4 ++-- docs/tutorial.mdx | 2 +- sidebars-main.js | 5 +++-- 107 files changed, 336 insertions(+), 149 deletions(-) create mode 100644 docs/how-to-guides/licenses/ls-dyna/server-setup.md create mode 100644 docs/how-to-guides/support/index.md diff --git a/docs/changelog.md b/docs/changelog.md index add4353..c12c685 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -5,11 +5,6 @@ description: Notable changes to Vantage. # Changelog -Changelog entries are published with each product release. Check back here for updates on new features, improvements, and bug fixes. - -Notable recent changes: +For detailed release notes, see our [GitHub releases](https://github.com/vantagecompute/vantage-docs/releases). -- **Storage section added:** PVCs, NFS, and CephFS how-to guides for Kubernetes clusters. -- **Clusters section restructured:** New get-started, concepts, and provider-specific how-to guides. - -For detailed release notes, see the [GitHub releases page](https://github.com/vantagecompute/v8x/releases). +Changelog entries are published with each product release. Check back here for updates on new features, improvements, and bug fixes. diff --git a/docs/explanation/clusters.mdx b/docs/explanation/clusters.mdx index e56da47..e1be4db 100644 --- a/docs/explanation/clusters.mdx +++ b/docs/explanation/clusters.mdx @@ -1,5 +1,5 @@ --- -title: Concepts +title: Clusters description: Mental models that show up across every cluster type. sidebar_position: 2 --- diff --git a/docs/explanation/compute-providers.mdx b/docs/explanation/compute-providers.mdx index 2d2bf69..822d155 100644 --- a/docs/explanation/compute-providers.mdx +++ b/docs/explanation/compute-providers.mdx @@ -1,5 +1,5 @@ --- -title: Concepts +title: Compute providers description: Three mental models behind every cloud account in Vantage. sidebar_position: 2 --- @@ -16,7 +16,7 @@ One cloud account can back multiple clusters. ## Providers -Vantage supports six provider types: +Vantage supports **five** provider types: | Provider | What it's for | |---|---| diff --git a/docs/explanation/concepts/jobs-and-pipelines.md b/docs/explanation/concepts/jobs-and-pipelines.md index 80941eb..92b5619 100644 --- a/docs/explanation/concepts/jobs-and-pipelines.md +++ b/docs/explanation/concepts/jobs-and-pipelines.md @@ -1,11 +1,11 @@ --- title: Jobs and pipelines -description: Finite computational work and the DAGs that orchestrate it. +description: Finite computational work and the directed acyclic graphs (DAGs) that orchestrate it. --- # Jobs and pipelines -Jobs are finite computational workloads, single-shot or distributed. Pipelines are multi-step DAGs that string jobs (and other steps) together for ingestion, training, evaluation, and deployment. +Jobs are finite computational workloads, single-shot or distributed. Pipelines are multi-step directed acyclic graphs (DAGs) that string jobs (and other steps) together for ingestion, training, evaluation, and deployment. ## Scripts and submissions @@ -17,7 +17,7 @@ Vantage stores scripts in a script library with version history. You can create Templates are Jinja2-based blueprints with parameterized variables. Write a template once with placeholders for dataset paths, cluster config, or resource requirements. When you render it, Vantage fills in the values and produces a concrete script. -Use templates when your team needs standardized job definitions, you control the structure, they fill in the parameters. +Use templates when your team needs standardized job definitions. You control the structure, and they fill in the parameters. ## Pipelines @@ -28,4 +28,4 @@ Unlike a single job that runs a self-contained workload, a pipeline coordinates ## Cross-references - [Jobs concepts](/explanation/jobs): scripts, templates, submissions, and the pipeline flow in detail -- Jobs, scripts, templates, and submissions have their own full section under [Platform > Jobs](/reference/jobs). Pipelines are covered under [Platform > Workbench > Pipelines](/reference/workbench/pipelines). This page is just the high-level picture. +- Jobs, scripts, templates, and submissions have their own full section under [Reference: Jobs](/reference/jobs). Pipelines are covered under [Reference: Workbench Pipelines](/reference/workbench/pipelines). This page is just the high-level picture. diff --git a/docs/explanation/concepts/teams-and-iam.md b/docs/explanation/concepts/teams-and-iam.md index de9c7b6..a5ca687 100644 --- a/docs/explanation/concepts/teams-and-iam.md +++ b/docs/explanation/concepts/teams-and-iam.md @@ -5,6 +5,10 @@ description: How permissions, ownership, and collaboration work. # Teams and IAM +:::note +This page provides a combined overview. For deeper coverage, see [Teams](/explanation/teams) and [IAM](/explanation/iam). +::: + Teams group users and own resources. IAM (identity and access management) controls what each team member can do, read, write, delete, deploy. Every resource in Vantage belongs to a team, and every action is authorized against that team's permissions. ## Teams @@ -19,7 +23,11 @@ Vantage uses role-based access control (RBAC). A role is a set of permissions, c ## Resource ownership -Every resource tracks who created it and which team it belongs to. Ownership controls who can modify or delete it. When you leave a team, your personal resources remain, the team admin can reassign ownership if needed. +Every resource tracks who created it and which team it belongs to. Ownership controls who can modify or delete it. When you leave a team, your personal resources remain. The team admin can reassign ownership if needed. + +## Roles vs. permission groups + +Roles and permission groups are independent systems that control access at different levels. Roles are team-level tool permissions (for example, Admin, Engineer, Viewer within a team). Permission groups are platform-wide IAM scopes (for example, Full Admin, Cluster Admin). A user's effective access is the combination of both: their permission group determines what actions are available across the platform, and their team role determines what they can do within a specific team. ## Cross-references diff --git a/docs/explanation/concepts/why-teams-and-iam.md b/docs/explanation/concepts/why-teams-and-iam.md index 9d53430..5e884b2 100644 --- a/docs/explanation/concepts/why-teams-and-iam.md +++ b/docs/explanation/concepts/why-teams-and-iam.md @@ -62,7 +62,7 @@ The ML Research team owns a workspace with four A100 GPUs. The Platform Engineer - **Alice** can see the A100 workspace (team membership) and can do anything in it (Full Admin permissions), create sessions, manage storage, invite members, adjust quota. - **Bob** can see the same A100 workspace (same team) but can only run workloads and manage his own resources (Regular User permissions). He cannot invite new members or adjust quota. -- **Carol** cannot see the A100 workspace at all, she is not on the ML Research team. She can manage clusters across the organization (Cluster Admin permissions), but only within the workspaces her team owns. +- **Carol** cannot see the A100 workspace at all because she is not on the ML Research team. She can manage clusters across the organization (Cluster Admin permissions), but only within the workspaces her team owns. If Alice shares a storage volume with Platform Engineering, Carol can see that volume. But her actions on it are still governed by her IAM permissions and any access level Alice set when sharing. diff --git a/docs/explanation/concepts/workbench-ml-stack.md b/docs/explanation/concepts/workbench-ml-stack.md index 019d3cc..510ac48 100644 --- a/docs/explanation/concepts/workbench-ml-stack.md +++ b/docs/explanation/concepts/workbench-ml-stack.md @@ -53,7 +53,7 @@ Development is interactive, exploratory work, writing code, loading data, testin Sessions start from a **preset:** a reusable template that bundles the IDE type, base container image, compute sizes, and default storage volumes. Presets standardize what "a development environment" looks like across a team, so every engineer gets the same image, the same libraries, and the same GPU options without configuring them from scratch. -For lighter-weight access, **Cloud Shell** provides a browser terminal and **Remote Desktop** provides VNC-based GUI access. Both are cheaper and faster to spin up than a full session. +For lighter-weight access, **Cloud Shell** provides a browser terminal and **Remote Desktop** provides noVNC-based GUI access. Both are cheaper and faster to spin up than a full session. The develop phase is where most time is spent and where iteration speed matters most. Sessions give you a full environment with the same compute you will eventually train on, so there is no "it worked on my laptop" gap between development and training. @@ -73,7 +73,7 @@ The relationship between these components: a pipeline may orchestrate several tr Serving bridges the gap between a trained model and a production API. -The **model registry** is a versioned catalog of model artifacts. Sources include HuggingFace, training job outputs, or direct uploads. Each model can have multiple versions. The registry is the handoff point, it decouples "who produced this model" from "who is deploying it." +The **model registry** is a versioned catalog of model artifacts. Sources include HuggingFace, training job outputs, or direct uploads. Each model can have multiple versions. The registry is the handoff point. It decouples "who produced this model" from "who is deploying it." **Endpoints** serve a registered model behind an authenticated, autoscaling HTTP URL. Workbench distinguishes two endpoint kinds because their tuning surfaces are different: diff --git a/docs/explanation/concepts/workspaces.md b/docs/explanation/concepts/workspaces.md index 419af89..8cb4d2e 100644 --- a/docs/explanation/concepts/workspaces.md +++ b/docs/explanation/concepts/workspaces.md @@ -5,13 +5,13 @@ description: Your team's slice of the cluster, with quota, RBAC, and a cost enve # Workspaces -A workspace is your team's slice of the Vantage cluster. Workspaces hold quota (CPUs, memory, GPUs, storage), an RBAC scope, and a cost envelope. Resources you create in Vantage live inside one workspace at a time. The current workspace is shown in the top-right of the screen, switch with the workspace picker. +A workspace is your team's slice of the Vantage cluster. Workspaces hold quota (CPUs, memory, GPUs, storage), an RBAC scope, and a cost envelope. Resources you create in Vantage live inside one workspace at a time. The current workspace is shown in the top-right of the screen. Switch with the workspace picker. ## Quota Every workspace has a resource ceiling: CPU cores, memory, GPU count, and storage capacity. Quota is set by your admin and enforced at resource creation time. When you try to start a Workbench session or submit a job that would exceed the workspace quota, Vantage blocks it. -Quota is not the same as usage. A workspace might have 16 GPUs of quota but only 4 in active use, the remaining 12 are available for new workloads. Check your workspace's current utilization on the Dashboard. +Quota is not the same as usage. A workspace might have 16 GPUs of quota but only 4 in active use. The remaining 12 are available for new workloads. Check your workspace's current utilization on the Dashboard. ## Cost envelope diff --git a/docs/explanation/federations.mdx b/docs/explanation/federations.mdx index 68c9bfa..d66afbd 100644 --- a/docs/explanation/federations.mdx +++ b/docs/explanation/federations.mdx @@ -8,7 +8,7 @@ sidebar_position: 2 Federations answer a simple question: *what if you could submit a job without deciding which cluster should run it?* -A federation groups multiple Vantage clusters into a single logical compute pool. Instead of choosing a cluster at submission time, you choose the federation, and Vantage routes the job to a member cluster that has the capacity to run it. The individual clusters keep their own schedulers, partitions, compute pools, and configuration, the federation is a layer above them, not a replacement for them. +A federation groups multiple Vantage clusters into a single logical compute pool. Instead of choosing a cluster at submission time, you choose the federation, and Vantage routes the job to a member cluster that has the capacity to run it. The individual clusters keep their own schedulers, partitions, compute pools, and configuration. The federation is a layer above them, not a replacement for them. ## Why federations exist @@ -66,7 +66,7 @@ Federations are not limited to a single scheduler or provider. A single federati - **On-premises clusters** alongside cloud clusters - **Clusters provisioned through different methods** (CloudFormation, Terraform, Ansible, Juju, manual connector) -This flexibility is what makes federations useful for hybrid and multi-cloud strategies. The federation does not need its member clusters to be identical, it only needs them to be registered in Vantage and in a `Ready` state. +This flexibility is what makes federations useful for hybrid and multi-cloud strategies. The federation does not need its member clusters to be identical. It only needs them to be registered in Vantage and in a `Ready` state. However, keep in mind that a Slurm job script is not interchangeable with a Kubernetes workload definition. If a federation contains both Slurm and Kubernetes clusters, routing will only consider clusters whose scheduler type matches the submitted job type. diff --git a/docs/explanation/iam.mdx b/docs/explanation/iam.mdx index 3d6ec3e..47a937b 100644 --- a/docs/explanation/iam.mdx +++ b/docs/explanation/iam.mdx @@ -1,5 +1,5 @@ --- -title: Concepts +title: IAM description: Four mental models behind IAM in Vantage. --- diff --git a/docs/explanation/jobs.mdx b/docs/explanation/jobs.mdx index f3cdc44..1ae3c64 100644 --- a/docs/explanation/jobs.mdx +++ b/docs/explanation/jobs.mdx @@ -1,5 +1,5 @@ --- -title: Concepts +title: Jobs description: Key mental models for the Jobs section, including scripts, templates, submissions, and the relationships between them. --- diff --git a/docs/explanation/licenses.mdx b/docs/explanation/licenses.mdx index 01085fc..6076a3a 100644 --- a/docs/explanation/licenses.mdx +++ b/docs/explanation/licenses.mdx @@ -1,5 +1,5 @@ --- -title: Concepts +title: Licenses description: Four mental models behind license management in Vantage. --- diff --git a/docs/explanation/storage.mdx b/docs/explanation/storage.mdx index 8a2e3d1..0925d82 100644 --- a/docs/explanation/storage.mdx +++ b/docs/explanation/storage.mdx @@ -1,5 +1,5 @@ --- -title: Concepts +title: Storage description: Storage types, namespaces, access modes, and storage classes in Vantage. sidebar_position: 2 --- @@ -14,7 +14,7 @@ Vantage exposes three storage primitives on Kubernetes clusters. | Type | What it is | Best for | |---|---|---| -| **PVC** | A Persistent Volume Claim backed by a storage class on the cluster | Single-namespace workloads that need durable block or file storage | +| **PVC (Persistent Volume Claim)** | A storage request backed by a storage class on the cluster | Single-namespace workloads that need durable block or file storage | | **NFS** | A network file share, either an external NFS server or a PVC exposed over NFS | Sharing data across namespaces or mounting the same volume in multiple pods simultaneously | | **CephFS** | A CephFS filesystem, from an internal PVC, an external Ceph cluster, or a system storage class | High-throughput parallel access across many nodes | diff --git a/docs/explanation/teams.mdx b/docs/explanation/teams.mdx index 07e6f03..b69710c 100644 --- a/docs/explanation/teams.mdx +++ b/docs/explanation/teams.mdx @@ -1,5 +1,5 @@ --- -title: Concepts +title: Teams description: Four mental models behind Teams and IAM. --- diff --git a/docs/explanation/workbench.mdx b/docs/explanation/workbench.mdx index 8472d4c..5972d8a 100644 --- a/docs/explanation/workbench.mdx +++ b/docs/explanation/workbench.mdx @@ -17,7 +17,7 @@ A reusable template (WorkspaceKind) that defines what a session looks like befor ## Service -A lightweight, browser-accessible tool that runs on cluster compute. Services include [Cloud Shell](/reference/workbench/cloud-shell) (terminal access), [Remote Desktop](/reference/workbench/remote-desktop) (VNC GUI), and [PVC Viewer](/reference/workbench/pvc-viewer) (file browser). They share a common lifecycle: create, open, and delete. They are also cheaper and faster to spin up than a full session. +A lightweight, browser-accessible tool that runs on cluster compute. Services include [Cloud Shell](/reference/workbench/cloud-shell) (terminal access), [Remote Desktop](/reference/workbench/remote-desktop) (noVNC GUI), and [PVC Viewer](/reference/workbench/pvc-viewer) (file browser). They share a common lifecycle: create, open, and delete. They are also cheaper and faster to spin up than a full session. ## Compute pool @@ -41,4 +41,10 @@ Every active resource accumulates spend. Workbench shows three numbers: **$/hr** ## Observability -Detail pages link out to Grafana dashboards scoped to that resource. Cluster-wide metrics live on the [Observability tab](/reference/workbench/observability). \ No newline at end of file +Detail pages link out to Grafana dashboards scoped to that resource. Cluster-wide metrics live on the [Observability tab](/reference/workbench/observability). + +## See also + +- [Pipeline anatomy](/explanation/workbench/pipeline-anatomy) +- [Sweep algorithms](/explanation/workbench/sweep-algorithms) +- [Predictive vs. LLM endpoints](/explanation/workbench/predictive-vs-llm) \ No newline at end of file diff --git a/docs/glossary.md b/docs/glossary.md index 835a2c1..5529b6e 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -11,7 +11,7 @@ description: Terms used across the Vantage docs. **API key:** A token used for programmatic access to the Vantage API. Generated from your profile settings. -**Authentication:** How you prove identity to Vantage. Options: OAuth (sign in with Google or GitHub) or federated SSO (your own identity provider via OIDC). +**Authentication:** How you prove identity to Vantage. Options: OAuth (sign in with Google or GitHub) or federated SSO (your own identity provider via OpenID Connect, or OIDC). **Canary:** A new endpoint version receiving a fraction of traffic during a rollout. Gradually shifts traffic as confidence increases. @@ -23,6 +23,8 @@ description: Terms used across the Vantage docs. **Cluster:** A physical Kubernetes or Slurm cluster Vantage manages. Workspaces live inside clusters; users can switch between clusters their team has access to. +**Compute pool:** A pool of identically-sized machines on a Kubernetes cluster (formerly called a node group), scaled up and down automatically. Each compute pool is a billing unit. + **Compute profile:** Reusable shape of compute (GPU + count + instance type + bounds). **Compute provider:** A supported source of compute: AWS, Azure, GCP, LXD, or On-Premises. Each has different credential requirements and capabilities. @@ -55,8 +57,6 @@ description: Terms used across the Vantage docs. **Node:** A single machine in a cluster that runs workloads. Cloud nodes are provisioned and deprovisioned automatically by Vantage. -**Compute pool:** A pool of identically-sized machines on a Kubernetes cluster (formerly called a node group), scaled up and down automatically. Each compute pool is a billing unit. - **Organization:** The top-level account containing all your users, teams, clusters, and resources. Billing and global settings are managed at the organization level. **Partition:** A job queue on a Slurm cluster. Each partition targets a pool of nodes and applies rules: max run time, allowed users, priority class. @@ -65,16 +65,19 @@ description: Terms used across the Vantage docs. **Persistent Volume Claim (PVC):** A Kubernetes storage request backed by a storage class. Namespace-scoped and tied to a specific performance tier. -**Pipeline:** A multi-step DAG of containerized tasks. +**Pipeline:** A multi-step directed acyclic graph (DAG) of containerized tasks. **Preset:** A pre-configured session environment that pins image, compute profile, and storage settings. Useful for standardizing team development environments. **Runtime:** A pre-built training environment that combines a framework, image, and parallelism strategy. -**Service:** An add-on capability within Workbench: Cloud Shell (browser terminal), Remote Desktop (X2Go GUI), or PVC Viewer (file browser). + +**Service:** An add-on capability within Workbench: Cloud Shell (browser terminal), Remote Desktop (noVNC GUI), or PVC Viewer (file browser). **Session:** An interactive notebook or development environment (JupyterLab, VS Code, RStudio) running on managed compute. +**Slurm:** An open-source job scheduler for HPC clusters, used by Vantage for batch workload scheduling and resource management. + **Storage class:** A Kubernetes storage profile that defines the provisioner, performance tier, and reclaim policy for PVCs. **Sweep:** A hyperparameter-search experiment containing many trial runs. @@ -89,4 +92,6 @@ description: Terms used across the Vantage docs. **Vantage-hosted:** A license server Vantage manages for you. Automatic updates, monitoring, and high availability. -**Workspace:** Your team's slice of the Vantage cluster, with quota, RBAC, and a cost envelope. +**Workbench:** The Vantage module for interactive development sessions, training jobs, inference endpoints, and ML pipelines. + +**Workspace:** Your team's slice of the Vantage cluster, with quota, role-based access control (RBAC), and a cost envelope. diff --git a/docs/how-to-guides/catalog/deploy-nim-model.mdx b/docs/how-to-guides/catalog/deploy-nim-model.mdx index b533b12..1db5b38 100644 --- a/docs/how-to-guides/catalog/deploy-nim-model.mdx +++ b/docs/how-to-guides/catalog/deploy-nim-model.mdx @@ -5,7 +5,7 @@ description: Walk through the four-step deploy wizard to launch an NVIDIA NIM in # Deploy a NIM model from the Catalog -Use the NIM deploy wizard when you want to serve one of the 277 curated NVIDIA NIM models as an inference endpoint. The wizard handles version selection, GPU compatibility, platform choice, scaling, and ingress in four steps. +Use the NIM deploy wizard when you want to serve one of the hundreds of curated NVIDIA NIM models as an inference endpoint. The wizard handles version selection, GPU compatibility, platform choice, scaling, and ingress in four steps.

diff --git a/docs/how-to-guides/catalog/get-started.mdx b/docs/how-to-guides/catalog/get-started.mdx index dd5b55b..ef7ad07 100644 --- a/docs/how-to-guides/catalog/get-started.mdx +++ b/docs/how-to-guides/catalog/get-started.mdx @@ -36,7 +36,7 @@ Click **Catalog** in the left sidebar to open the Catalog. Five tabs organize th | Source | What it contains | |---|---| -| **NVIDIA NIM** | 277 curated inference microservices. Each model ships as an optimized container with a built-in deploy wizard. | +| **NVIDIA NIM** | Hundreds of curated inference microservices. Each model ships as an optimized container with a built-in deploy wizard. | | **Hugging Face** | Models synced from Hugging Face Hub metadata. Browse the synced catalog or add a specific model by its Hub Model ID. | | **Local** | Your organization's own registered models. Models registered here can be deployed the same way as NIM or Hugging Face models. | | **NGC Containers** | Framework images for training, workspace, and serving workloads (e.g. NeMo Framework, PyTorch, Triton Inference Server, CUDA, JAX). | diff --git a/docs/how-to-guides/cloud-accounts/connect-cloud-account.mdx b/docs/how-to-guides/cloud-accounts/connect-cloud-account.mdx index 3b7d959..c1e7ddc 100644 --- a/docs/how-to-guides/cloud-accounts/connect-cloud-account.mdx +++ b/docs/how-to-guides/cloud-accounts/connect-cloud-account.mdx @@ -143,6 +143,8 @@ The Vantage IAM role needs the following permission categories: The assisted setup CloudFormation template configures these permissions automatically. +Success looks like this: running `uvx v8x cloud-account list` shows your new account with provider `aws`. + @@ -235,7 +237,7 @@ Click `Create Cloud Account`.

-Success looks like this: the new account appears in `uvx v8x cloud account list` with provider `azure` and is ready to back a cluster. +Success looks like this: the new account appears in `uvx v8x cloud-account list` with provider `azure` and is ready to back a cluster. diff --git a/docs/how-to-guides/clusters/get-started.mdx b/docs/how-to-guides/clusters/get-started.mdx index 7a8afea..6d12521 100644 --- a/docs/how-to-guides/clusters/get-started.mdx +++ b/docs/how-to-guides/clusters/get-started.mdx @@ -70,7 +70,7 @@ After your first cluster is connected, dive deeper into your cluster type: | Guide | What it covers | |---|---| | [Creating a Slurm cluster](/how-to-guides/clusters/slurm/create) | Provider-specific steps for Slurm | -| [Creating a Kubernetes cluster](/how-to-guides/clusters/kubernetes/create) | Provider-specific steps for K8s | +| [Creating a Kubernetes cluster](/how-to-guides/clusters/kubernetes/create) | Provider-specific steps for Kubernetes | | [Slurm partitions](/reference/clusters/slurm/partitions) | Managing job queues | | [Kubernetes compute pools](/reference/clusters/kubernetes/node-groups) | Managing compute pools | | [On-Premises clusters](/how-to-guides/clusters/on-premises) | Ansible, Terraform, Kubernetes, Juju, Multipass, or manual setup | diff --git a/docs/how-to-guides/clusters/index.md b/docs/how-to-guides/clusters/index.md index 7779638..5fcdd3b 100644 --- a/docs/how-to-guides/clusters/index.md +++ b/docs/how-to-guides/clusters/index.md @@ -1,9 +1,9 @@ --- -title: How-to guides +title: Clusters description: Task-oriented guides for creating, managing, and troubleshooting Slurm and Kubernetes clusters. --- -# How-to guides +# Clusters Step-by-step guides for Slurm and Kubernetes clusters on every supported provider. @@ -14,7 +14,7 @@ Step-by-step guides for Slurm and Kubernetes clusters on every supported provide ### Slurm - [Create a Slurm cluster](/how-to-guides/clusters/slurm/create): Step-by-step for every supported provider -- [Slurm on Kubernetes](/how-to-guides/clusters/slurm-on-kubernetes): Deploy Slurm HPC on top of an existing K8s cluster +- [Slurm on Kubernetes](/how-to-guides/clusters/slurm-on-kubernetes): Deploy Slurm HPC on top of an existing Kubernetes cluster - [Configure Slurm partitions](/how-to-guides/clusters/slurm/configure-partitions): Add, edit, and delete partitions ### Kubernetes diff --git a/docs/how-to-guides/clusters/kubernetes/create.mdx b/docs/how-to-guides/clusters/kubernetes/create.mdx index 7ad62b8..4eea4e4 100644 --- a/docs/how-to-guides/clusters/kubernetes/create.mdx +++ b/docs/how-to-guides/clusters/kubernetes/create.mdx @@ -38,7 +38,7 @@ import TabItem from '@theme/TabItem'; -AWS K8s clusters use direct boto3 API calls (not CloudFormation) to provision infrastructure. Vantage creates the VPC, IAM roles, security groups, and launches a control plane EC2 instance with MicroK8s pre-configured. +AWS Kubernetes clusters use direct boto3 API calls (not CloudFormation) to provision infrastructure. Vantage creates the VPC, IAM roles, security groups, and launches a control plane EC2 instance with MicroK8s pre-configured.
diff --git a/docs/how-to-guides/clusters/on-premises.mdx b/docs/how-to-guides/clusters/on-premises.mdx index 08cc502..f25e38c 100644 --- a/docs/how-to-guides/clusters/on-premises.mdx +++ b/docs/how-to-guides/clusters/on-premises.mdx @@ -192,7 +192,7 @@ The Terraform module supports both Snap (default) and PyPI installation methods. -Connect an existing Kubernetes cluster to Vantage. Vantage does not provision cloud resources for on-premises K8s, you provide the compute infrastructure. +Connect an existing Kubernetes cluster to Vantage. Vantage does not provision cloud resources for on-premises Kubernetes clusters; you provide the compute infrastructure. ### Prerequisites diff --git a/docs/how-to-guides/clusters/troubleshooting.mdx b/docs/how-to-guides/clusters/troubleshooting.mdx index 5646f16..6e1441f 100644 --- a/docs/how-to-guides/clusters/troubleshooting.mdx +++ b/docs/how-to-guides/clusters/troubleshooting.mdx @@ -86,7 +86,7 @@ Create an SSH key pair in the target AWS region through the EC2 console. Vantage ## Compute pool or partition shows zero nodes - **Cloud clusters:** Verify the minimum size is set to at least 1 if you expect nodes to always be present. Autoscaling scales to zero when `min_size = 0`. -- **Slurm on Kubernetes:** Ensure the parent K8s cluster has sufficient capacity and the autoscaler is enabled. The AWS autoscaler uses EC2 Fleet to provision instances. +- **Slurm on Kubernetes:** Ensure the parent Kubernetes cluster has sufficient capacity and the autoscaler is enabled. The AWS autoscaler uses EC2 Fleet to provision instances. - **On-premises clusters:** Nodes must be registered manually on your infrastructure. Install the Vantage connector on each node. See [On-Premises clusters](/how-to-guides/clusters/on-premises) and use the Manual tab for details. ## Cluster not appearing in the list diff --git a/docs/how-to-guides/developer-tools/cli/deploy-slurm-local.mdx b/docs/how-to-guides/developer-tools/cli/deploy-slurm-local.mdx index ea34dab..729f8bb 100644 --- a/docs/how-to-guides/developer-tools/cli/deploy-slurm-local.mdx +++ b/docs/how-to-guides/developer-tools/cli/deploy-slurm-local.mdx @@ -31,7 +31,7 @@ The v8x can deploy Slurm clusters to local development environments using deploy Start by exploring the deployment applications available for localhost: ```bash -uvx v8x app list --provider localhost +uvx v8x app list --provider on_prem ``` The relevant applications for local Slurm are: @@ -45,15 +45,15 @@ The relevant applications for local Slurm are: ## Create a localhost cloud account -Before deploying a cluster, create a cloud account for the `localhost` provider: +Before deploying a cluster, create a cloud account for the `on_prem` provider: ```bash -uvx v8x cloud account create my-localhost --provider localhost +uvx v8x cloud account create my-localhost --provider on_prem ``` This registers your local machine as a compute target. The command returns the cloud account ID, which you need in the next step. -Success looks like this: the new account appears in `uvx v8x cloud account list` with provider `localhost`. +Success looks like this: the new account appears in `uvx v8x cloud account list` with provider `on_prem`.
diff --git a/docs/how-to-guides/developer-tools/cli/deployment-applications/localhost/index.mdx b/docs/how-to-guides/developer-tools/cli/deployment-applications/localhost/index.mdx index bf5db34..7931c83 100644 --- a/docs/how-to-guides/developer-tools/cli/deployment-applications/localhost/index.mdx +++ b/docs/how-to-guides/developer-tools/cli/deployment-applications/localhost/index.mdx @@ -82,7 +82,7 @@ Proceed to Multipass Singlenode Deployment Application Documentation. +Multipass is now installed. Proceed to the Multipass Single-node Deployment Application Documentation. ### Charmed HPC diff --git a/docs/how-to-guides/iam/tutorials.mdx b/docs/how-to-guides/iam/tutorials.mdx index a7998b2..957e063 100644 --- a/docs/how-to-guides/iam/tutorials.mdx +++ b/docs/how-to-guides/iam/tutorials.mdx @@ -29,7 +29,7 @@ sidebar_label: IAM setup walkthrough ## Set up SSO with your identity provider -This tutorial walks through configuring federated SSO so users can sign in with your corporate identity provider instead of Google or GitHub OAuth. +This walkthrough covers configuring federated SSO so users can sign in with your corporate identity provider instead of Google or GitHub OAuth. **Prerequisites:** Admin access to your Vantage organization and your identity provider's OIDC or SAML configuration details. diff --git a/docs/how-to-guides/jobs/get-started.mdx b/docs/how-to-guides/jobs/get-started.mdx index ced9463..444ed1b 100644 --- a/docs/how-to-guides/jobs/get-started.mdx +++ b/docs/how-to-guides/jobs/get-started.mdx @@ -4,7 +4,7 @@ description: From a fresh workspace to a completed job in under five minutes. sidebar_position: 1 --- -# Quickstart +# Get started with jobs

diff --git a/docs/how-to-guides/jobs/scripts/creating.mdx b/docs/how-to-guides/jobs/scripts/creating.mdx index 42a3fe9..23d4915 100644 --- a/docs/how-to-guides/jobs/scripts/creating.mdx +++ b/docs/how-to-guides/jobs/scripts/creating.mdx @@ -30,3 +30,13 @@ Click the pencil icon on any file row to open the built-in editor, syntax highli ## Add support files Click **Add Support File** below the file table, give it a name, and upload the file (max 5 MB). Repeat for as many support files as you need. To update an existing one, click the file row and re-upload. + +

+ +## What to do next + +- [Submit a job](/how-to-guides/jobs/submissions/submitting) +- [Manage job scripts](/how-to-guides/jobs/scripts/managing) +- [Create job templates](/how-to-guides/jobs/templates/creating) for reusable parameterized scripts + +
diff --git a/docs/how-to-guides/jobs/scripts/managing.mdx b/docs/how-to-guides/jobs/scripts/managing.mdx index 05244f7..8521684 100644 --- a/docs/how-to-guides/jobs/scripts/managing.mdx +++ b/docs/how-to-guides/jobs/scripts/managing.mdx @@ -32,3 +32,13 @@ Select multiple scripts using the checkboxes, then use the toolbar to archive, r Name, description, and files can be changed from the detail page. Click **Edit** to toggle the form. Success looks like this: the change is applied, and subsequent list or get commands reflect the updated script. + +
+ +## What to do next + +- [Create a job script](/how-to-guides/jobs/scripts/creating) +- [Submit a job](/how-to-guides/jobs/submissions/submitting) +- [Monitor submissions](/how-to-guides/jobs/submissions/monitoring) + +
diff --git a/docs/how-to-guides/jobs/submissions/monitoring.mdx b/docs/how-to-guides/jobs/submissions/monitoring.mdx index 3d7292e..c2ad12e 100644 --- a/docs/how-to-guides/jobs/submissions/monitoring.mdx +++ b/docs/how-to-guides/jobs/submissions/monitoring.mdx @@ -63,3 +63,13 @@ Table listing all sbatch arguments passed at submission, including the auto-gene ## Slurm Job Info tab Available after the submission reaches Slurm. Displays a searchable JSON tree viewer showing the raw `scontrol show job` output. Use it to debug scheduling decisions, resource allocations, or Slurm-level error messages. + +
+ +## What to do next + +- [Submit a job](/how-to-guides/jobs/submissions/submitting) +- [Manage job scripts](/how-to-guides/jobs/scripts/managing) +- [Create job templates](/how-to-guides/jobs/templates/creating) for reusable parameterized scripts + +
diff --git a/docs/how-to-guides/jobs/templates/creating.mdx b/docs/how-to-guides/jobs/templates/creating.mdx index f561160..3c07b28 100644 --- a/docs/how-to-guides/jobs/templates/creating.mdx +++ b/docs/how-to-guides/jobs/templates/creating.mdx @@ -32,3 +32,13 @@ If no entrypoint file is uploaded, a blank `entrypoint.py.j2` is auto-created. After creation, you land on the template detail page. Success looks like this: the template is created and appears in `uvx v8x job template list`, ready to generate scripts. + +
+ +## What to do next + +- [Use job templates](/how-to-guides/jobs/templates/using) to render a template into a script +- [Manage job templates](/how-to-guides/jobs/templates/managing) +- [Template workflow](/how-to-guides/jobs/templates/workflow) for the full render-to-submit walkthrough + +
diff --git a/docs/how-to-guides/jobs/templates/managing.mdx b/docs/how-to-guides/jobs/templates/managing.mdx index c247a64..9a9b85e 100644 --- a/docs/how-to-guides/jobs/templates/managing.mdx +++ b/docs/how-to-guides/jobs/templates/managing.mdx @@ -3,7 +3,7 @@ title: Managing Templates description: Clone, archive, delete, and manage template identifiers and variables. --- -# Managing Templates +# Manage job templates ## Actions @@ -32,3 +32,13 @@ Success looks like this: the change is applied, and subsequent list or get comma ## Filters You can filter the template list by source (all or only mine), by whether the template has an identifier, or by archived status. + +
+ +## What to do next + +- [Create a job template](/how-to-guides/jobs/templates/creating) +- [Use job templates](/how-to-guides/jobs/templates/using) to render a template into a script +- [Submit a job](/how-to-guides/jobs/submissions/submitting) + +
diff --git a/docs/how-to-guides/jobs/templates/using.mdx b/docs/how-to-guides/jobs/templates/using.mdx index 8aa6aa1..5b689b1 100644 --- a/docs/how-to-guides/jobs/templates/using.mdx +++ b/docs/how-to-guides/jobs/templates/using.mdx @@ -3,7 +3,9 @@ title: Using Templates description: Render a template to generate a concrete job script. --- -# Using Templates +# Use job templates + +For a complete walkthrough, see [Template workflow](/how-to-guides/jobs/templates/workflow). **Render Template to Script** is accessible from the template list row's action menu or the template detail page. diff --git a/docs/how-to-guides/licenses/dsls/high-availability.md b/docs/how-to-guides/licenses/dsls/high-availability.md index 2e9963f..3021bc8 100644 --- a/docs/how-to-guides/licenses/dsls/high-availability.md +++ b/docs/how-to-guides/licenses/dsls/high-availability.md @@ -1,6 +1,6 @@ --- id: high-availability -title: High Availability +title: DSLS High Availability sidebar_position: 4 description: High availability, redundancy, and disaster recovery configuration for DSLS license servers. --- diff --git a/docs/how-to-guides/licenses/dsls/index.mdx b/docs/how-to-guides/licenses/dsls/index.mdx index 28086f3..0f43202 100644 --- a/docs/how-to-guides/licenses/dsls/index.mdx +++ b/docs/how-to-guides/licenses/dsls/index.mdx @@ -1,6 +1,6 @@ --- id: introduction -title: Introduction +title: DSLS Introduction sidebar_position: 1 description: Comprehensive DSLS license management with Vantage License Manager integration. --- diff --git a/docs/how-to-guides/licenses/dsls/monitoring.md b/docs/how-to-guides/licenses/dsls/monitoring.md index 7c2e8ab..cee6321 100644 --- a/docs/how-to-guides/licenses/dsls/monitoring.md +++ b/docs/how-to-guides/licenses/dsls/monitoring.md @@ -1,6 +1,6 @@ --- id: monitoring -title: Monitoring & Analytics +title: DSLS Monitoring & Analytics sidebar_position: 3 description: Comprehensive monitoring, analytics, and optimization for DSLS license servers through Vantage integration. --- diff --git a/docs/how-to-guides/licenses/dsls/server-setup.mdx b/docs/how-to-guides/licenses/dsls/server-setup.mdx index 0a18165..8b2f148 100644 --- a/docs/how-to-guides/licenses/dsls/server-setup.mdx +++ b/docs/how-to-guides/licenses/dsls/server-setup.mdx @@ -1,6 +1,6 @@ --- id: server-setup -title: Server Setup +title: DSLS Server Setup sidebar_position: 2 description: Installation and configuration of DSLS license servers with Vantage integration. --- diff --git a/docs/how-to-guides/licenses/dsls/troubleshooting.md b/docs/how-to-guides/licenses/dsls/troubleshooting.md index 436f980..4653356 100644 --- a/docs/how-to-guides/licenses/dsls/troubleshooting.md +++ b/docs/how-to-guides/licenses/dsls/troubleshooting.md @@ -1,6 +1,6 @@ --- id: troubleshooting -title: Troubleshooting +title: DSLS Troubleshooting sidebar_position: 5 description: Comprehensive troubleshooting guide for DSLS license servers, token management, and Vantage integration. --- diff --git a/docs/how-to-guides/licenses/flexlm/high-availability.md b/docs/how-to-guides/licenses/flexlm/high-availability.md index 3f775af..ffc0a47 100644 --- a/docs/how-to-guides/licenses/flexlm/high-availability.md +++ b/docs/how-to-guides/licenses/flexlm/high-availability.md @@ -1,6 +1,6 @@ --- id: high-availability -title: High Availability +title: FlexLM High Availability sidebar_position: 4 description: Configure FlexLM for high availability in Vantage environments. --- diff --git a/docs/how-to-guides/licenses/flexlm/index.md b/docs/how-to-guides/licenses/flexlm/index.md index 8109411..80704af 100644 --- a/docs/how-to-guides/licenses/flexlm/index.md +++ b/docs/how-to-guides/licenses/flexlm/index.md @@ -62,7 +62,7 @@ FlexLM is used by many major engineering and scientific software vendors: ### Other Major Applications - **MATLAB**: Technical computing platform -- **Abaqus**: Finite element analysis +- **Abaqus** (legacy; current versions use DSLS): Finite element analysis - **LS-DYNA**: Explicit dynamic simulation - **Cadence tools**: Electronic design automation diff --git a/docs/how-to-guides/licenses/flexlm/monitoring.md b/docs/how-to-guides/licenses/flexlm/monitoring.md index be55521..974ba7f 100644 --- a/docs/how-to-guides/licenses/flexlm/monitoring.md +++ b/docs/how-to-guides/licenses/flexlm/monitoring.md @@ -1,6 +1,6 @@ --- id: monitoring -title: Monitoring & Analytics +title: FlexLM Monitoring & Analytics sidebar_position: 4 description: Use Vantage's license usage dashboard to monitor FlexLM utilization across users, teams, departments, and clusters. --- diff --git a/docs/how-to-guides/licenses/flexlm/server-setup.md b/docs/how-to-guides/licenses/flexlm/server-setup.md index 3f32a7f..0f86766 100644 --- a/docs/how-to-guides/licenses/flexlm/server-setup.md +++ b/docs/how-to-guides/licenses/flexlm/server-setup.md @@ -1,6 +1,6 @@ --- id: server-setup -title: Server Setup +title: FlexLM Server Setup sidebar_position: 2 description: FlexLM license server installation and configuration for Vantage integration. --- @@ -34,7 +34,7 @@ sudo cp lmgrd vendor_daemon /opt/flexlm/bin/ ```bash # Example: /opt/flexlm/licenses/ansys.lic -SERVER license-server.vantage.com 001122334455 27000 +SERVER license-server.example.com 001122334455 27000 DAEMON ansyslmd /opt/flexlm/bin/ansyslmd USE_SERVER @@ -95,9 +95,10 @@ sudo journalctl -u flexlm-ansys -f ```bash # /etc/environment -ANSYSLMD_LICENSE_FILE=27000@license-server.vantage.com -LM_LICENSE_FILE=27000@license-server.vantage.com -ALTAIR_LICENSE_PATH=6200@license-server.vantage.com +# Default FlexLM port; see application-specific overrides below +ANSYSLMD_LICENSE_FILE=27000@license-server.example.com +LM_LICENSE_FILE=27000@license-server.example.com +ALTAIR_LICENSE_PATH=27000@license-server.example.com ``` ### Application-Specific Configuration @@ -105,7 +106,8 @@ ALTAIR_LICENSE_PATH=6200@license-server.vantage.com **ANSYS Configuration**: ```bash # ANSYS licensing setup -export ANSYSLMD_LICENSE_FILE="1055@license-server.vantage.com" +# ANSYS may use port 1055 (ANSYS License Manager) instead of 27000 +export ANSYSLMD_LICENSE_FILE="1055@license-server.example.com" export ANSYS_FLEXLM_DISABLE_DEFLM=1 # For Fluent @@ -113,10 +115,12 @@ export FLUENT_LICENSING=flex export FLUENT_LICENSE_FILE="$ANSYSLMD_LICENSE_FILE" ``` + + **MATLAB Configuration**: ```bash # MATLAB network license -export MLM_LICENSE_FILE="27000@license-server.vantage.com" +export MLM_LICENSE_FILE="27000@license-server.example.com" # Test MATLAB licensing matlab -batch "license('test', 'MATLAB')" @@ -225,7 +229,7 @@ EOF #!/bin/bash # /opt/flexlm/bin/health-check.sh -FLEXLM_SERVER="27000@license-server.vantage.com" +FLEXLM_SERVER="27000@license-server.example.com" LOG_FILE="/var/log/flexlm/health-check.log" check_server() { @@ -274,7 +278,7 @@ fi uvx v8x licenses add \ --type flexlm \ --vendor ansys \ - --server license-server.vantage.com:27000 \ + --server license-server.example.com:27000 \ --daemon ansyslmd \ --name "Production ANSYS FlexLM" \ --description "Main ANSYS license server for production workloads" diff --git a/docs/how-to-guides/licenses/flexlm/troubleshooting.md b/docs/how-to-guides/licenses/flexlm/troubleshooting.md index a96b209..5215166 100644 --- a/docs/how-to-guides/licenses/flexlm/troubleshooting.md +++ b/docs/how-to-guides/licenses/flexlm/troubleshooting.md @@ -1,6 +1,6 @@ --- id: troubleshooting -title: Troubleshooting +title: FlexLM Troubleshooting sidebar_position: 5 description: Diagnose and resolve common FlexLM issues in Vantage environments. --- @@ -809,4 +809,4 @@ uvx v8x licenses monitor backup-server --alert-threshold 90 --- -> **Emergency Contact**: For critical license server issues affecting production workloads, contact your Vantage support team immediately at support@vantage.com or use the emergency escalation procedures in your support agreement. +> **Emergency Contact**: For critical license server issues affecting production workloads, contact your Vantage support team immediately at support@vantagecompute.ai or use the emergency escalation procedures in your support agreement. diff --git a/docs/how-to-guides/licenses/flexlm/user-managed-server-setup.md b/docs/how-to-guides/licenses/flexlm/user-managed-server-setup.md index dff425b..85d4fd2 100644 --- a/docs/how-to-guides/licenses/flexlm/user-managed-server-setup.md +++ b/docs/how-to-guides/licenses/flexlm/user-managed-server-setup.md @@ -112,6 +112,8 @@ sudo chmod +x vantage-license-monitor sudo ./vantage-license-monitor install --server-type flexlm --server-port 27000 ``` + + ### 3. Verify Integration ```bash diff --git a/docs/how-to-guides/licenses/index.md b/docs/how-to-guides/licenses/index.md index 062d94b..2b18326 100644 --- a/docs/how-to-guides/licenses/index.md +++ b/docs/how-to-guides/licenses/index.md @@ -18,4 +18,4 @@ Choose your license server type below for setup, monitoring, and high-availabili Each guide covers the same standard sections: introduction, server setup, Vantage-managed and user-managed deployment options, monitoring, high availability, and troubleshooting. -New to license server management? Start with [Concepts](/explanation/licenses) or the [Quickstart](/how-to-guides/licenses/). +New to license server management? Start with [Concepts](/explanation/licenses) or the [Quickstart](/how-to-guides/licenses/get-started). diff --git a/docs/how-to-guides/licenses/inventory.mdx b/docs/how-to-guides/licenses/inventory.mdx index 2f042a2..e4716db 100644 --- a/docs/how-to-guides/licenses/inventory.mdx +++ b/docs/how-to-guides/licenses/inventory.mdx @@ -170,4 +170,4 @@ If demand consistently exceeds capacity, contact your license vendor to add seat - [How-to guides for each license server type](/how-to-guides/licenses) -- setup, monitoring, and troubleshooting per server - [License concepts](/explanation/licenses) -- how licenses integrate with jobs -- [Quickstart](/how-to-guides/licenses/) -- connect a license server in under five minutes +- [Quickstart](/how-to-guides/licenses/get-started) -- connect a license server in under five minutes diff --git a/docs/how-to-guides/licenses/lmx/high-availability.md b/docs/how-to-guides/licenses/lmx/high-availability.md index ad320c4..c932092 100644 --- a/docs/how-to-guides/licenses/lmx/high-availability.md +++ b/docs/how-to-guides/licenses/lmx/high-availability.md @@ -1,6 +1,6 @@ --- id: high-availability -title: High Availability +title: LMX High Availability sidebar_position: 4 description: Configure redundant LMX license servers for enterprise reliability and failover. --- diff --git a/docs/how-to-guides/licenses/lmx/monitoring.md b/docs/how-to-guides/licenses/lmx/monitoring.md index 1c42e08..712b5d9 100644 --- a/docs/how-to-guides/licenses/lmx/monitoring.md +++ b/docs/how-to-guides/licenses/lmx/monitoring.md @@ -1,6 +1,6 @@ --- id: monitoring -title: Monitoring & Analytics +title: LMX Monitoring & Analytics sidebar_position: 3 description: Comprehensive LMX license usage monitoring and analytics through Vantage dashboard. --- diff --git a/docs/how-to-guides/licenses/lmx/server-setup.md b/docs/how-to-guides/licenses/lmx/server-setup.md index 4651521..e3078e7 100644 --- a/docs/how-to-guides/licenses/lmx/server-setup.md +++ b/docs/how-to-guides/licenses/lmx/server-setup.md @@ -1,6 +1,6 @@ --- id: server-setup -title: Server Setup +title: LMX Server Setup sidebar_position: 2 description: Install and configure LMX license server with Vantage integration. --- @@ -374,7 +374,7 @@ uvx v8x licenses add lmx-server \ --port 6200 \ --web-port 8080 \ --web-ssl-port 8443 \ - --web-username uvx v8x \ + --web-username vantage-readonly \ --web-password-file /etc/vantage/lmx-readonly-password \ --ssl-verify false \ --description "Primary LMX server for ANSYS and COMSOL licenses" @@ -405,7 +405,7 @@ uvx v8x licenses optimize lmx-server \ # Create secure password file for Vantage integration echo "VantageReadonlyPassword" | sudo tee /etc/vantage/lmx-readonly-password sudo chmod 600 /etc/vantage/lmx-readonly-password -sudo chown vantage:uvx v8x /etc/vantage/lmx-readonly-password +sudo chown vantage:vantage /etc/vantage/lmx-readonly-password # Configure API access for advanced integration uvx v8x licenses api-config lmx-server \ diff --git a/docs/how-to-guides/licenses/lmx/troubleshooting.md b/docs/how-to-guides/licenses/lmx/troubleshooting.md index a502cf2..ebb414f 100644 --- a/docs/how-to-guides/licenses/lmx/troubleshooting.md +++ b/docs/how-to-guides/licenses/lmx/troubleshooting.md @@ -1,6 +1,6 @@ --- id: troubleshooting -title: Troubleshooting +title: LMX Troubleshooting sidebar_position: 5 description: Diagnose and resolve common LMX license server issues in Vantage environments. --- @@ -1012,4 +1012,4 @@ uvx v8x licenses monitor lmx-secondary --alert-threshold 90 --- -> **Emergency Contact**: For critical LMX server issues affecting production workloads, contact your Vantage support team immediately at support@vantage.com. LMX's borrowing feature often allows work to continue even during server outages, but proper monitoring and quick resolution are essential for maintaining user productivity. The web interface provides additional diagnostic capabilities beyond command-line tools. +> **Emergency Contact**: For critical LMX server issues affecting production workloads, contact your Vantage support team immediately at support@vantagecompute.ai. LMX's borrowing feature often allows work to continue even during server outages, but proper monitoring and quick resolution are essential for maintaining user productivity. The web interface provides additional diagnostic capabilities beyond command-line tools. diff --git a/docs/how-to-guides/licenses/ls-dyna/high-availability.md b/docs/how-to-guides/licenses/ls-dyna/high-availability.md index 378b069..9f67997 100644 --- a/docs/how-to-guides/licenses/ls-dyna/high-availability.md +++ b/docs/how-to-guides/licenses/ls-dyna/high-availability.md @@ -1,6 +1,6 @@ --- id: high-availability -title: High Availability +title: LS-DYNA High Availability sidebar_position: 4 description: Configure redundant LSTC license servers for enterprise LS-DYNA reliability. --- diff --git a/docs/how-to-guides/licenses/ls-dyna/index.md b/docs/how-to-guides/licenses/ls-dyna/index.md index faa95ae..e2827a8 100644 --- a/docs/how-to-guides/licenses/ls-dyna/index.md +++ b/docs/how-to-guides/licenses/ls-dyna/index.md @@ -2,12 +2,12 @@ id: introduction title: LS-DYNA License Manager sidebar_position: 4 -description: LS-DYNA LSTC license management integration with Vantage platform. +description: LS-DYNA LSTC license management integration with the Vantage platform. --- # LS-DYNA License Manager -LS-DYNA License Manager by Livermore Software Technology Corporation (LSTC) provides specialized license management for LS-DYNA explicit finite element analysis software. This system offers unique features including solver-specific licensing, parallel processing tokens, and advanced analytics capabilities that integrate seamlessly with the Vantage platform for comprehensive license optimization and monitoring. +LS-DYNA License Manager by Livermore Software Technology Corporation (LSTC), now part of Ansys, provides specialized license management for LS-DYNA explicit finite element analysis software. This system offers unique features including solver-specific licensing, parallel processing tokens, and advanced analytics capabilities that integrate seamlessly with the Vantage platform for comprehensive license optimization and monitoring. ## Overview diff --git a/docs/how-to-guides/licenses/ls-dyna/monitoring.md b/docs/how-to-guides/licenses/ls-dyna/monitoring.md index c75e643..63143d0 100644 --- a/docs/how-to-guides/licenses/ls-dyna/monitoring.md +++ b/docs/how-to-guides/licenses/ls-dyna/monitoring.md @@ -1,6 +1,6 @@ --- id: monitoring -title: Monitoring & Analytics +title: LS-DYNA Monitoring & Analytics sidebar_position: 3 description: Comprehensive LS-DYNA license monitoring using Vantage License Manager dashboard analytics. --- diff --git a/docs/how-to-guides/licenses/ls-dyna/server-setup.md b/docs/how-to-guides/licenses/ls-dyna/server-setup.md new file mode 100644 index 0000000..d2e1437 --- /dev/null +++ b/docs/how-to-guides/licenses/ls-dyna/server-setup.md @@ -0,0 +1,15 @@ +--- +id: server-setup +title: LS-DYNA Server Setup +sidebar_position: 2 +description: LS-DYNA license server installation and configuration for Vantage integration. +--- + +# LS-DYNA Server Setup + +Choose a deployment model for your LS-DYNA license server: + +- **[Vantage-Managed Setup](/how-to-guides/licenses/ls-dyna/vantage-managed-server-setup)**: Vantage handles all infrastructure, maintenance, and monitoring. +- **[User-Managed Setup](/how-to-guides/licenses/ls-dyna/user-managed-server-setup)**: You host and manage the LS-DYNA license server yourself, with Vantage integration for monitoring and analytics. + +For an overview of LS-DYNA licensing concepts, see the [LS-DYNA introduction](/how-to-guides/licenses/ls-dyna). diff --git a/docs/how-to-guides/licenses/ls-dyna/troubleshooting.md b/docs/how-to-guides/licenses/ls-dyna/troubleshooting.md index 3f4ee4f..22c2448 100644 --- a/docs/how-to-guides/licenses/ls-dyna/troubleshooting.md +++ b/docs/how-to-guides/licenses/ls-dyna/troubleshooting.md @@ -1,6 +1,6 @@ --- id: troubleshooting -title: Troubleshooting +title: LS-DYNA Troubleshooting sidebar_position: 5 description: Resolve common LS-DYNA license issues, solver problems, and parallel token failures. --- diff --git a/docs/how-to-guides/licenses/ls-dyna/user-managed-server-setup.md b/docs/how-to-guides/licenses/ls-dyna/user-managed-server-setup.md index 7f2fb02..22bf9fd 100644 --- a/docs/how-to-guides/licenses/ls-dyna/user-managed-server-setup.md +++ b/docs/how-to-guides/licenses/ls-dyna/user-managed-server-setup.md @@ -16,7 +16,7 @@ Before setting up your LS-DYNA license server, ensure you have: - **Server Hardware**: Dedicated server meeting LSTC requirements - **Network Access**: Connectivity between your license server and Vantage infrastructure - **Administrative Access**: Root/administrator privileges on the target server -- **LSTC Account**: Valid account with Livermore Software Technology Corporation +- **LSTC Account**: Valid account with Livermore Software Technology Corporation (LSTC), now part of Ansys ## Supported Operating Systems @@ -154,6 +154,7 @@ sudo cat >> /opt/lstc/server/lstc.conf << EOF QUEUE_PRIORITY_ENABLED=YES USER_PRIORITY_FILE=/opt/lstc/server/user_priorities.conf MEMORY_BASED_QUEUING=YES +# SMP_LIMIT caps total SMP threads SMP_LIMIT=128 MPP_LIMIT=1024 EOF @@ -258,6 +259,7 @@ EOF sudo cat >> /opt/lstc/server/lstc.conf << EOF # SMP Optimization SMP_CORES_PER_LICENSE=1 +# SMP_MAX_CORES caps per-job cores SMP_MAX_CORES=64 SMP_QUEUE_PRIORITY=HIGH EOF @@ -500,12 +502,12 @@ echo "0 2 * * * root /opt/lstc/backup-lstc.sh" | sudo tee -a /etc/crontab ### Environment Configuration ```bash -# Set LS-DYNA environment variables +# Single server export LSTC_LICENSE_SERVER=lstc-server:31010 export LSTC_MEMORY_LICENSING=yes export LSTC_MAX_MEMORY=32GB -# For multiple servers +# High-availability (HA) configuration export LSTC_LICENSE_SERVER=lstc1:31010,lstc2:31010 ``` @@ -589,7 +591,9 @@ USER lstc WORKDIR /opt/lstc/server CMD ["./lstc_qrun_server", "-config", "/opt/lstc/server/lstc.conf"] EOF +``` +```bash # Build and run container docker build -t lstc-server . docker run -d -p 31010:31010 -p 31011:31011 --name lstc-server lstc-server diff --git a/docs/how-to-guides/licenses/olicense/high-availability.md b/docs/how-to-guides/licenses/olicense/high-availability.md index 52dac7d..0649f5e 100644 --- a/docs/how-to-guides/licenses/olicense/high-availability.md +++ b/docs/how-to-guides/licenses/olicense/high-availability.md @@ -1,6 +1,6 @@ --- id: high-availability -title: High Availability +title: OLicense High Availability sidebar_position: 4 description: High availability, redundancy, and disaster recovery configuration for OLicense servers. --- diff --git a/docs/how-to-guides/licenses/olicense/index.md b/docs/how-to-guides/licenses/olicense/index.md index b2e376b..80f8aa1 100644 --- a/docs/how-to-guides/licenses/olicense/index.md +++ b/docs/how-to-guides/licenses/olicense/index.md @@ -1,10 +1,12 @@ --- id: introduction -title: Introduction +title: OLicense Introduction sidebar_position: 1 description: Overview of OLicense management integration with Vantage for enterprise software licensing. --- + + # OLicense License Management OLicense is a sophisticated license management system developed by Optimal Computing Solutions that provides advanced floating license capabilities, usage analytics, and enterprise integration features. The Vantage License Manager offers comprehensive integration with OLicense servers, providing centralized monitoring, cost optimization, and automated license management for organizations using OLicense-protected software. diff --git a/docs/how-to-guides/licenses/olicense/monitoring.md b/docs/how-to-guides/licenses/olicense/monitoring.md index 758f381..31e26d8 100644 --- a/docs/how-to-guides/licenses/olicense/monitoring.md +++ b/docs/how-to-guides/licenses/olicense/monitoring.md @@ -1,6 +1,6 @@ --- id: monitoring -title: Monitoring & Analytics +title: OLicense Monitoring & Analytics sidebar_position: 3 description: Monitor OLicense servers and analyze license usage with Vantage dashboards and advanced analytics. --- diff --git a/docs/how-to-guides/licenses/olicense/server-setup.md b/docs/how-to-guides/licenses/olicense/server-setup.md index 9d7ef59..175537f 100644 --- a/docs/how-to-guides/licenses/olicense/server-setup.md +++ b/docs/how-to-guides/licenses/olicense/server-setup.md @@ -1,6 +1,6 @@ --- id: server-setup -title: Server Setup +title: OLicense Server Setup sidebar_position: 2 description: Deploy and configure OLicense servers with enterprise database integration and high availability. --- diff --git a/docs/how-to-guides/licenses/olicense/troubleshooting.md b/docs/how-to-guides/licenses/olicense/troubleshooting.md index f5a1718..5d921e7 100644 --- a/docs/how-to-guides/licenses/olicense/troubleshooting.md +++ b/docs/how-to-guides/licenses/olicense/troubleshooting.md @@ -1,6 +1,6 @@ --- id: troubleshooting -title: Troubleshooting +title: OLicense Troubleshooting sidebar_position: 5 description: Comprehensive troubleshooting guide for OLicense servers, enterprise features, and Vantage integration. --- diff --git a/docs/how-to-guides/licenses/rlm/high-availability.md b/docs/how-to-guides/licenses/rlm/high-availability.md index 88193a6..75b48ae 100644 --- a/docs/how-to-guides/licenses/rlm/high-availability.md +++ b/docs/how-to-guides/licenses/rlm/high-availability.md @@ -1,6 +1,6 @@ --- id: high-availability -title: High Availability +title: RLM High Availability sidebar_position: 4 description: Configure RLM for high availability in Vantage environments. --- diff --git a/docs/how-to-guides/licenses/rlm/monitoring.md b/docs/how-to-guides/licenses/rlm/monitoring.md index a3df7d7..4f3ded6 100644 --- a/docs/how-to-guides/licenses/rlm/monitoring.md +++ b/docs/how-to-guides/licenses/rlm/monitoring.md @@ -1,6 +1,6 @@ --- id: monitoring -title: Monitoring & Analytics +title: RLM Monitoring & Analytics sidebar_position: 3 description: Comprehensive RLM monitoring using Vantage License Manager dashboard analytics. --- diff --git a/docs/how-to-guides/licenses/rlm/server-setup.md b/docs/how-to-guides/licenses/rlm/server-setup.md index d1752f5..94889d5 100644 --- a/docs/how-to-guides/licenses/rlm/server-setup.md +++ b/docs/how-to-guides/licenses/rlm/server-setup.md @@ -1,6 +1,6 @@ --- id: server-setup -title: Server Setup +title: RLM Server Setup sidebar_position: 2 description: RLM license server installation and configuration for Vantage integration. --- diff --git a/docs/how-to-guides/licenses/rlm/troubleshooting.md b/docs/how-to-guides/licenses/rlm/troubleshooting.md index 292e2b1..be2d5f5 100644 --- a/docs/how-to-guides/licenses/rlm/troubleshooting.md +++ b/docs/how-to-guides/licenses/rlm/troubleshooting.md @@ -1,6 +1,6 @@ --- id: troubleshooting -title: Troubleshooting +title: RLM Troubleshooting sidebar_position: 5 description: Diagnose and resolve common RLM issues in Vantage environments. --- @@ -843,4 +843,4 @@ uvx v8x licenses monitor backup-rlm-server --alert-threshold 90 --- -> **Emergency Contact**: For critical RLM server issues affecting production workloads, contact your Vantage support team immediately at support@vantage.com or use the emergency escalation procedures in your support agreement. The RLM web interface often provides additional diagnostic information beyond command-line tools. +> **Emergency Contact**: For critical RLM server issues affecting production workloads, contact your Vantage support team immediately at support@vantagecompute.ai or use the emergency escalation procedures in your support agreement. The RLM web interface often provides additional diagnostic information beyond command-line tools. diff --git a/docs/how-to-guides/licenses/rlm/vantage-managed-server-setup.md b/docs/how-to-guides/licenses/rlm/vantage-managed-server-setup.md index 46f7c46..5366c55 100644 --- a/docs/how-to-guides/licenses/rlm/vantage-managed-server-setup.md +++ b/docs/how-to-guides/licenses/rlm/vantage-managed-server-setup.md @@ -115,7 +115,7 @@ spec: configuration: server_port: 5053 - web_port: 4954 + web_port: 5054 ssl_enabled: true admin_interface: true debug_logging: false diff --git a/docs/how-to-guides/licenses/tutorials.mdx b/docs/how-to-guides/licenses/tutorials.mdx index 2c3de0e..a6347af 100644 --- a/docs/how-to-guides/licenses/tutorials.mdx +++ b/docs/how-to-guides/licenses/tutorials.mdx @@ -1,6 +1,6 @@ --- -title: Tutorials -description: Walk through setting up a license server end-to-end. +title: FlexLM Setup Walkthrough +description: Walk through setting up a FlexLM license server end-to-end. --- # Licenses, Tutorials @@ -26,6 +26,10 @@ description: Walk through setting up a license server end-to-end.
+:::note +This walkthrough covers FlexLM. For other license managers, see the [server-setup guide](/how-to-guides/licenses) for your license type. +::: + ## Set up a FlexLM license server This tutorial walks through setting up a FlexLM license server connected to Vantage. diff --git a/docs/how-to-guides/storage/cephfs.mdx b/docs/how-to-guides/storage/cephfs.mdx index f4c3650..3a4f156 100644 --- a/docs/how-to-guides/storage/cephfs.mdx +++ b/docs/how-to-guides/storage/cephfs.mdx @@ -17,7 +17,7 @@ description: Attach a CephFS filesystem from an internal PVC, an external Ceph c
You will need - A Kubernetes cluster in ready state + A Kubernetes cluster in Connected state
Outcome diff --git a/docs/how-to-guides/storage/get-started.mdx b/docs/how-to-guides/storage/get-started.mdx index 3e08055..9ee80e7 100644 --- a/docs/how-to-guides/storage/get-started.mdx +++ b/docs/how-to-guides/storage/get-started.mdx @@ -4,7 +4,7 @@ description: Navigate the storage sections on a Kubernetes cluster and create yo sidebar_position: 1 --- -# Quickstart +# Get started with storage

Create a volume claim on a Kubernetes cluster in under a minute.

@@ -88,7 +88,10 @@ PVCs are namespace-scoped. If your job and your PVC are in different namespaces, - [Work with PVCs](/how-to-guides/storage/pvcs) - [Create object storage buckets](/how-to-guides/storage/object-storage) - [Work with NFS](/how-to-guides/storage/nfs) +- [Work with CephFS](/how-to-guides/storage/cephfs) - [Mount storage in sessions](/how-to-guides/storage/mounting-in-sessions) +- [Mount storage in jobs](/how-to-guides/storage/mounting-in-jobs) - [Mount storage in training jobs](/how-to-guides/storage/mounting-in-training-jobs) +- [Mount storage in endpoints](/how-to-guides/storage/mounting-in-endpoints)
diff --git a/docs/how-to-guides/storage/index.md b/docs/how-to-guides/storage/index.md index 13bcbac..e7dd34a 100644 --- a/docs/how-to-guides/storage/index.md +++ b/docs/how-to-guides/storage/index.md @@ -1,9 +1,9 @@ --- -title: How-to guides +title: Storage description: Step-by-step guides for managing storage on Kubernetes clusters. --- -# How-to guides +# Storage Step-by-step guides for the storage types available on Kubernetes clusters. Storage is located under **Infrastructure**, then **Storage** in the cluster sidebar. @@ -12,3 +12,7 @@ Step-by-step guides for the storage types available on Kubernetes clusters. Stor - [Object storage](/how-to-guides/storage/object-storage): Create and manage S3-compatible buckets - [NFS](/how-to-guides/storage/nfs): Mount an external NFS server or expose a PVC as an NFS share - [CephFS](/how-to-guides/storage/cephfs): Attach a CephFS filesystem (internal, external, or system) +- [Mount storage in sessions](/how-to-guides/storage/mounting-in-sessions): Attach volumes to Workbench sessions +- [Mount storage in jobs](/how-to-guides/storage/mounting-in-jobs): Attach volumes to training jobs (Slurm) +- [Mount storage in training jobs](/how-to-guides/storage/mounting-in-training-jobs): Attach volumes to Workbench training jobs +- [Mount storage in endpoints](/how-to-guides/storage/mounting-in-endpoints): Mount PVCs into endpoint pods diff --git a/docs/how-to-guides/storage/mounting-in-endpoints.mdx b/docs/how-to-guides/storage/mounting-in-endpoints.mdx index 68f7b99..2e7f101 100644 --- a/docs/how-to-guides/storage/mounting-in-endpoints.mdx +++ b/docs/how-to-guides/storage/mounting-in-endpoints.mdx @@ -77,8 +77,6 @@ In the runtime configuration, point the model path to the mount location: MODEL_PATH=/models/my-model.pt ``` -Success looks like this: the endpoint is created with the storage mounted, and users can access files through the endpoint interface. -
@@ -89,6 +87,8 @@ Complete the rest of the form and click `Deploy`.
+Success looks like this: the endpoint is created with the storage mounted, and users can access files through the endpoint interface. + The endpoint pods mount the PVC at startup. Scaling replicas share the same PVC (requires `ReadOnlyMany` or `ReadWriteMany` access mode). ## Access mode considerations diff --git a/docs/how-to-guides/storage/mounting-in-sessions.mdx b/docs/how-to-guides/storage/mounting-in-sessions.mdx index 195c8f7..2ba17fb 100644 --- a/docs/how-to-guides/storage/mounting-in-sessions.mdx +++ b/docs/how-to-guides/storage/mounting-in-sessions.mdx @@ -19,7 +19,7 @@ Workbench sessions can mount external storage volumes so your notebooks and scri
You will need - A cluster in ready status, a storage volume already created + A cluster in Connected status, a storage volume already created
Outcome diff --git a/docs/how-to-guides/storage/nfs.mdx b/docs/how-to-guides/storage/nfs.mdx index 12bf68e..7770912 100644 --- a/docs/how-to-guides/storage/nfs.mdx +++ b/docs/how-to-guides/storage/nfs.mdx @@ -17,7 +17,7 @@ description: Mount an external NFS server or expose an existing PVC as an NFS sh
You will need - A Kubernetes cluster in ready state + A Kubernetes cluster in Connected state
Outcome diff --git a/docs/how-to-guides/support/index.md b/docs/how-to-guides/support/index.md new file mode 100644 index 0000000..7cef255 --- /dev/null +++ b/docs/how-to-guides/support/index.md @@ -0,0 +1,9 @@ +--- +title: Support +description: Submit support tickets and get help. +--- + +# Support + +- [Submit a ticket from the CLI](/how-to-guides/support/submit-ticket-cli) +- [Submit a ticket from the UI](/how-to-guides/support/submit-ticket-ui) diff --git a/docs/how-to-guides/teams/tutorials.mdx b/docs/how-to-guides/teams/tutorials.mdx index 8b6cddd..a86fc5f 100644 --- a/docs/how-to-guides/teams/tutorials.mdx +++ b/docs/how-to-guides/teams/tutorials.mdx @@ -29,7 +29,7 @@ sidebar_label: Team setup walkthrough ## Create a team, add members, and grant cluster access -This tutorial walks through setting up a team with controlled access to a cluster. +This walkthrough covers setting up a team with controlled access to a cluster. **Prerequisites:** Admin or Team Admin permissions in your organization, a connected cluster. diff --git a/docs/how-to-guides/workbench/observability.mdx b/docs/how-to-guides/workbench/observability.mdx index ce23048..d29c069 100644 --- a/docs/how-to-guides/workbench/observability.mdx +++ b/docs/how-to-guides/workbench/observability.mdx @@ -45,7 +45,7 @@ The top of the page shows six tiles: | Spend MTD | Month-to-date spend with an end-of-month forecast | | Idle GPU hours | GPU hours where utilization was below 5%; the metric to drive down | -If **Idle GPU hours** exceeds 20% of **Spend today**, sessions are likely being left open without active use. +If idle GPU-hour cost exceeds 20% of today's spend, sessions are likely being left open without active use. ## Charts diff --git a/docs/how-to-guides/workbench/serve/canary-rollouts.mdx b/docs/how-to-guides/workbench/serve/canary-rollouts.mdx index 2377cf9..1969ec9 100644 --- a/docs/how-to-guides/workbench/serve/canary-rollouts.mdx +++ b/docs/how-to-guides/workbench/serve/canary-rollouts.mdx @@ -56,7 +56,7 @@ Success looks like this: the endpoint detail page shows the current canary perce
-The current Workbench UI displays canary traffic state but does not expose promote or rollback buttons on the endpoint detail page. Use your team's release process or API workflow to change rollout state. +The current Workbench UI displays canary traffic state but does not expose promote or rollback buttons on the endpoint detail page. Use your team's release process or the [API reference](/reference/developer-tools/api) to change rollout state.
diff --git a/docs/how-to-guides/workbench/train/pipelines/creating.mdx b/docs/how-to-guides/workbench/train/pipelines/creating.mdx index f8a093e..7b886c3 100644 --- a/docs/how-to-guides/workbench/train/pipelines/creating.mdx +++ b/docs/how-to-guides/workbench/train/pipelines/creating.mdx @@ -6,7 +6,7 @@ description: Build a multi-step pipeline from the Vantage SDK and view it in the # Create a pipeline :::warning -Pipelines are in early access. UI authoring is not yet available. Use the SDK to create pipelines. +Pipelines are in preview. UI authoring is not yet available. Use the SDK to create pipelines. ::: Pipelines are multi-step DAGs (directed acyclic graphs) that turn one-off scripts into reproducible, schedulable workflows. Each step runs in its own container with explicit inputs, outputs, and dependencies. diff --git a/docs/how-to-guides/workbench/troubleshooting.mdx b/docs/how-to-guides/workbench/troubleshooting.mdx index f5cb38a..392b329 100644 --- a/docs/how-to-guides/workbench/troubleshooting.mdx +++ b/docs/how-to-guides/workbench/troubleshooting.mdx @@ -27,7 +27,7 @@ By default the Logs tab streams the trainer master pod. If your master finished ## Pipeline and sweep limitations -Both tabs are in **Preview**. Today: +Both tabs are in **preview**. Today: - Pipeline authoring is API-first. The UI shows experiments, pipelines, runs, recurring runs, artifacts, and executions. - Sweep creation is available from the UI when algorithms, runtimes, and compute pools are configured. The list and detail views show trials and sweep progress. diff --git a/docs/index.md b/docs/index.md index 1376c97..6cfb4ac 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,7 @@ slug: / # Vantage Compute Documentation -**Virtually Limitless™ Compute:** Execute AI, HPC, and Quantum workloads across any environment with a unified platform for Slurm+Kubernetes orchestration. +**Virtually Limitless™ Compute:** Execute AI, HPC, and Quantum workloads across any environment with a unified platform for Slurm and Kubernetes orchestration. [Tutorial](/tutorial) · [How-to Guides](/how-to-guides/cloud-accounts/get-started) · [Explanation](/explanation) · [Book a Demo](https://vantagecompute.ai/contact) diff --git a/docs/reference/clusters/kubernetes/manage.mdx b/docs/reference/clusters/kubernetes/manage.mdx index 99ebbf4..728f516 100644 --- a/docs/reference/clusters/kubernetes/manage.mdx +++ b/docs/reference/clusters/kubernetes/manage.mdx @@ -13,8 +13,8 @@ A Kubernetes cluster has two status indicators: | Status | Meaning | |---|---| -| **CONNECTED** | The cluster agent is online and communicating normally | -| **NOT CONNECTED** | The agent is unreachable. Check network connectivity or agent health | +| **Connected** | The cluster agent is online and communicating normally | +| **Not Connected** | The agent is unreachable. Check network connectivity or agent health | **Deploy status** shows the current lifecycle state of the cluster: @@ -108,6 +108,10 @@ Grafana is automatically deployed when the cluster is created. ## Adding compute pools post-creation +:::tip +For step-by-step instructions, see [Manage a Kubernetes cluster](/how-to-guides/clusters/manage-cluster). +::: + 1. Open the cluster detail page and go to **Workloads**, then **Compute Pools** in the cluster sidebar. 2. Click **Add Compute Pool**. 3. Configure the pool: name, role, instance type (or profile for non-AWS), min/max size, and optional labels/taints. @@ -123,6 +127,10 @@ The Applications page is a read-only view of what is deployed on the cluster. It ## Deleting a cluster +:::tip +For step-by-step instructions, see [Manage a Kubernetes cluster](/how-to-guides/clusters/manage-cluster). +::: + 1. Open the cluster detail page. 2. Click the overflow menu (three dots) in the top-right corner. 3. Select **Delete Cluster** and confirm. diff --git a/docs/reference/clusters/kubernetes/node-groups.mdx b/docs/reference/clusters/kubernetes/node-groups.mdx index e356dd1..fe6d2a8 100644 --- a/docs/reference/clusters/kubernetes/node-groups.mdx +++ b/docs/reference/clusters/kubernetes/node-groups.mdx @@ -81,6 +81,10 @@ For AWS clusters, the autoscaler manages EC2 Fleet instances tagged with `vantag ## Best practices +:::tip +These are general recommendations. See the [Kubernetes how-to guides](/how-to-guides/clusters) for step-by-step procedures. +::: + - **Separate workload types into different compute pools:** GPU training jobs and CPU preprocessing should use different pools so they don't compete for resources. - **Set min sizes conservatively:** Idle nodes cost money. Start with min=0 and adjust once you understand your workload patterns. - **Use labels and taints for scheduling control:** Mark GPU compute pools with `nvidia.com/gpu: "true"` so only GPU workloads land on them. diff --git a/docs/reference/clusters/slurm/manage.mdx b/docs/reference/clusters/slurm/manage.mdx index df4e981..a2fab7e 100644 --- a/docs/reference/clusters/slurm/manage.mdx +++ b/docs/reference/clusters/slurm/manage.mdx @@ -11,16 +11,16 @@ A Slurm cluster moves through these statuses: | Status | Meaning | |---|---| -| `preparing` | Provisioning in progress. Vantage is creating cloud resources (if applicable) and waiting for nodes to register. | -| `ready` | Cluster is connected, Slurm configuration is uploaded, and the cluster is accepting jobs. | -| `failed` | Provisioning or runtime error. Check `creation_status_details` on the detail page for the specific error. | -| `deleting` | Cluster teardown in progress. Vantage is deprovisioning cloud resources and removing the database record. | +| **Preparing** | Provisioning in progress. Vantage is creating cloud resources (if applicable) and waiting for nodes to register. | +| **Ready** | Cluster is connected, Slurm configuration is uploaded, and the cluster is accepting jobs. | +| **Failed** | Provisioning or runtime error. Check the detail page for the specific error. | +| **Deleting** | Cluster teardown in progress. Vantage is deprovisioning cloud resources and removing the database record. | Transitions: -- `preparing` to `ready`: All nodes registered and Slurm config uploaded. -- `preparing` to `failed`: CloudFormation error, provisioning timeout, or node registration failure. -- `ready` to `deleting`: User initiated deletion. -- `failed` to `deleting`: User initiated deletion. +- **Preparing** to **Ready**: All nodes registered and Slurm config uploaded. +- **Preparing** to **Failed**: CloudFormation error, provisioning timeout, or node registration failure. +- **Ready** to **Deleting**: User initiated deletion. +- **Failed** to **Deleting**: User initiated deletion. ## Detail page sidebar diff --git a/docs/reference/clusters/slurm/partitions.mdx b/docs/reference/clusters/slurm/partitions.mdx index e503660..663f7a0 100644 --- a/docs/reference/clusters/slurm/partitions.mdx +++ b/docs/reference/clusters/slurm/partitions.mdx @@ -63,6 +63,10 @@ Cloud Slurm partitions use Vantage's autoscaler to manage node counts: ## Best practices +:::tip +These are general recommendations. See the [Slurm how-to guides](/how-to-guides/clusters) for step-by-step procedures. +::: + - **Separate workloads by resource profile:** Create CPU and GPU partitions so batch preprocessing doesn't block GPU nodes for training. - **Set max node counts conservatively:** Idle nodes cost money. Start low and raise when you've validated your workload patterns. - **Use the default partition:** Mark one partition as default so jobs that don't specify a partition still get scheduled. diff --git a/docs/reference/developer-tools/cli/commands.mdx b/docs/reference/developer-tools/cli/commands.mdx index 3901b76..c31f20a 100644 --- a/docs/reference/developer-tools/cli/commands.mdx +++ b/docs/reference/developer-tools/cli/commands.mdx @@ -43,6 +43,10 @@ This document provides a comprehensive reference for all available CLI commands ``` +:::note +`vdeployer-web` (Vantage's internal deployment service) handles background deployment operations for clusters. It is referenced in several commands below, including `cluster extend`, `cluster kubeflow create`, and `cluster slurm create`. +::: + ## Authentication Commands ### Login diff --git a/docs/reference/developer-tools/cli/index.md b/docs/reference/developer-tools/cli/index.md index 63fbfd7..f508626 100644 --- a/docs/reference/developer-tools/cli/index.md +++ b/docs/reference/developer-tools/cli/index.md @@ -22,9 +22,11 @@ Or from source: git clone https://github.com/vantagecompute/v8x cd v8x uv sync -uvx v8x --help +uv run v8x --help ``` +> **`uvx v8x` vs `uv run v8x`:** Use `uvx v8x` (shown above) to run the published package without a permanent install. Use `uv run v8x` only when running from a local source checkout. For a persistent install, run `uv tool install v8x`, which makes `v8x` available as a standalone command. + #### Authenticate Authenticate against the Vantage platform using the `login` command. @@ -33,7 +35,7 @@ Authenticate against the Vantage platform using the `login` command. uvx v8x login ``` -#### Create a Multipass Singlenode Cluster +#### Create a Multipass Single-node Cluster Create a cloud account first, then create the cluster: @@ -67,8 +69,8 @@ uvx v8x cluster create my-slurm-microk8s-cluster \ ### Next Steps -- [CLI Quickstart](/how-to-guides/developer-tools/cli/quickstart) – Install & Configure -- [Commands Reference](/reference/developer-tools/cli/commands) – Complete Command Reference -- [Private Installation Configuration](/how-to-guides/developer-tools/cli/private-vantage-installation) – Partner Vantage Deployment CLI Profile Configuration -- [Usage Examples](/how-to-guides/developer-tools/cli/usage) – Practical Command Patterns -- [Troubleshooting](/how-to-guides/developer-tools/cli/troubleshooting) – Common Issues and Solutions +- [CLI Quickstart](/how-to-guides/developer-tools/cli/quickstart) - Install and Configure +- [Commands Reference](/reference/developer-tools/cli/commands) - Complete Command Reference +- [Private Installation Configuration](/how-to-guides/developer-tools/cli/private-vantage-installation) - Partner Vantage Deployment CLI Profile Configuration +- [Usage Examples](/how-to-guides/developer-tools/cli/usage) - Practical Command Patterns +- [Troubleshooting](/how-to-guides/developer-tools/cli/troubleshooting) - Common Issues and Solutions diff --git a/docs/reference/licenses/reference.md b/docs/reference/licenses/reference.md index 56421ec..67eda2e 100644 --- a/docs/reference/licenses/reference.md +++ b/docs/reference/licenses/reference.md @@ -16,6 +16,8 @@ description: License server ports, protocols, and configuration fields. | DSLS | Varies by vendor | | OLicense | 7374 | + + ## Registration fields When adding a license server in Vantage, these fields are available: diff --git a/docs/reference/settings/iam/reference.md b/docs/reference/settings/iam/reference.md index 09a1d14..302c34a 100644 --- a/docs/reference/settings/iam/reference.md +++ b/docs/reference/settings/iam/reference.md @@ -5,17 +5,19 @@ description: Permission groups, authentication options, and API key settings. # IAM, Reference + + ## Built-in permission groups | Group | Permissions | |---|---| | Regular User | Standard platform access, create and manage own resources | -| Full Admin | Full platform administration, users, billing, all settings | +| Full Admin | Full platform administration, users, billing, all settings. Platform-wide access across all organizations. | | Cluster Admin | Manage clusters, create, update, delete, monitor | | Jobs Admin | Manage jobs and scripts, create, submit, cancel | | Licenses Admin | Manage license servers, add, configure, monitor | | Notebook Admin | Manage Workbench notebook sessions | -| Organization Admin | Manage organization settings, billing, and members | +| Organization Admin | Manage organization settings, billing, and members. Scoped to a single organization. | | Team Admin | Manage teams, create, add/remove members, configure access | ## Authentication methods diff --git a/docs/reference/workbench/compute-profiles/reference.mdx b/docs/reference/workbench/compute-profiles/reference.mdx index 9b58301..4f40325 100644 --- a/docs/reference/workbench/compute-profiles/reference.mdx +++ b/docs/reference/workbench/compute-profiles/reference.mdx @@ -7,6 +7,8 @@ description: Every field on a compute pool. Compute pools are managed by workspace admins. These are the fields you'll see on each pool. +{/* TODO(vantage): verify -- g5.48xlarge has A10G GPUs, not A100. Should this be p4d.24xlarge? */} + | Field | Description | |---|---| | Display name | What people see, e.g. `A100 x 4`. | diff --git a/docs/reference/workbench/endpoints/presets.mdx b/docs/reference/workbench/endpoints/presets.mdx index ecd413a..596c51f 100644 --- a/docs/reference/workbench/endpoints/presets.mdx +++ b/docs/reference/workbench/endpoints/presets.mdx @@ -5,6 +5,10 @@ description: Pre-configured endpoint defaults for quick deployment. # Presets +:::info +Not to be confused with [Session presets](/reference/workbench/presets), which define IDE, image, and compute defaults for interactive sessions. +::: + Endpoint presets are reusable configurations that bundle compute, replica counts, and runtime selections. Instead of filling out the full endpoint form every time, pick a preset and the deployment form pre-fills around it. ## The presets list diff --git a/docs/reference/workbench/endpoints/reference.mdx b/docs/reference/workbench/endpoints/reference.mdx index 99e1589..0ec30b8 100644 --- a/docs/reference/workbench/endpoints/reference.mdx +++ b/docs/reference/workbench/endpoints/reference.mdx @@ -11,8 +11,10 @@ Endpoint URL pattern, auth, and key fields. The detail page header shows the URL. Auth is handled by your workspace's ingress, pass your Vantage API key as a bearer token. The full URL pattern is: +{/* TODO(vantage): confirm the actual inference API hostname */} + ``` -POST https://{workspace}.vantage.ai/v1/{endpoint-name}/infer +POST https://{workspace}.vantagecompute.ai/v1/{endpoint-name}/infer Authorization: Bearer {your-api-key} ``` diff --git a/docs/reference/workbench/index.mdx b/docs/reference/workbench/index.mdx index 0c69a1f..759b26e 100644 --- a/docs/reference/workbench/index.mdx +++ b/docs/reference/workbench/index.mdx @@ -15,6 +15,7 @@ Workbench is where you build, train, and serve machine-learning models on Vantag - **[Remote Desktop](/reference/workbench/remote-desktop):** VNC-based remote desktop sessions for full GUI access to GPU nodes. - **[PVC Viewer](/reference/workbench/pvc-viewer):** Browser-based file browser for PersistentVolumeClaims. - **[Compute Profiles](/reference/workbench/compute-profiles):** The reusable shape of your compute: GPU type, count, autoscaling bounds, instance class. +{/* TODO(vantage): confirm Apple-silicon nodes are supported for cloud training */} - **[Training Jobs](/reference/workbench/training-jobs):** Distributed training on PyTorch, DeepSpeed, or MLX runtimes. Retry, suspend, resume. - **[Pipelines](/reference/workbench/pipelines):** Multi-step DAGs that orchestrate ingestion, training, evaluation, and deployment. - **[Sweeps](/reference/workbench/sweeps):** Hyperparameter search with Bayesian, grid, or random algorithms, tracked end-to-end. diff --git a/docs/reference/workbench/models/reference.mdx b/docs/reference/workbench/models/reference.mdx index 6efd19f..f161ab0 100644 --- a/docs/reference/workbench/models/reference.mdx +++ b/docs/reference/workbench/models/reference.mdx @@ -5,6 +5,8 @@ description: "Model fields and metadata." # Reference +{/* TODO(vantage): expand -- add versioning/format/size fields, explain Labels vs Custom properties */} + Every model carries these fields beyond name and version. | Field | Description | diff --git a/docs/reference/workbench/pipelines/runs.mdx b/docs/reference/workbench/pipelines/runs.mdx index 4473bdb..3fbf9c0 100644 --- a/docs/reference/workbench/pipelines/runs.mdx +++ b/docs/reference/workbench/pipelines/runs.mdx @@ -17,10 +17,20 @@ The list view shows every run across all experiments. Each row displays: - **Name:** the run's display name. - **Pipeline:** which pipeline version this run executes. -- **Status:** current phase (Running, Succeeded, Failed, Skipped). +- **Status:** current phase (Pending, Running, Succeeded, Failed, Skipped). - **Started:** when the run started. - **Duration:** elapsed time. +## Run statuses + +| Status | Meaning | +|---|---| +| **Pending** | The run is queued and waiting for resources to become available. | +| **Running** | The run is actively executing pipeline steps. | +| **Succeeded** | All steps completed successfully. | +| **Failed** | One or more steps errored. Check step-level logs for details. | +| **Skipped** | The run was bypassed due to a condition evaluation or manual cancellation. | + ## Run detail Click a run to see: diff --git a/docs/reference/workbench/presets/index.mdx b/docs/reference/workbench/presets/index.mdx index 6ae2202..494a064 100644 --- a/docs/reference/workbench/presets/index.mdx +++ b/docs/reference/workbench/presets/index.mdx @@ -5,6 +5,10 @@ description: Reusable templates that define which images, compute sizes, and sto # Presets +:::info +Not to be confused with [Endpoint presets](/reference/workbench/endpoints/presets), which define compute and replica defaults for inference endpoints. +::: + A **preset** (WorkspaceKind) is a reusable template that bundles the choices you make when creating a session, which IDE, which container images, which compute sizes, and which storage volumes are available. Instead of picking images and pod sizes from scratch every time, you select a preset and the wizard pre-fills around it. Presets appear across Workbench in three contexts: diff --git a/docs/reference/workbench/sessions/lifecycle.mdx b/docs/reference/workbench/sessions/lifecycle.mdx index 67fe14d..00295fc 100644 --- a/docs/reference/workbench/sessions/lifecycle.mdx +++ b/docs/reference/workbench/sessions/lifecycle.mdx @@ -36,6 +36,8 @@ Click any row name to open it. The detail page is split into: - **Activity:** chronological log of phase transitions, conditions, and reconcile errors. - **Observability:** embedded Grafana panel scoped to this session. +{/* TODO(vantage): verify this cost figure is current; consider moving to a pricing page */} + :::warning -**Idle sessions cost money.** A 4×A100 session left running overnight is roughly $400. Workbench will surface an "idle" warning, but it's on you to pause sessions you're not actively using. +**Idle sessions cost money.** A 4xA100 session left running overnight is roughly $400. Workbench will surface an "idle" warning, but it is on you to pause sessions you are not actively using. ::: \ No newline at end of file diff --git a/docs/reference/workbench/sessions/notebooks.md b/docs/reference/workbench/sessions/notebooks.md index a5d2715..7811112 100644 --- a/docs/reference/workbench/sessions/notebooks.md +++ b/docs/reference/workbench/sessions/notebooks.md @@ -4,6 +4,8 @@ title: Notebooks description: Jupyter, VS Code, and RStudio notebook environments. --- + + Vantage Workbench sessions provide JupyterLab, VS Code, and RStudio environments running on managed compute infrastructure. Launch a session, pick your compute pool, and start coding in minutes. ## Quickstart diff --git a/docs/reference/workbench/sessions/remote-desktops.md b/docs/reference/workbench/sessions/remote-desktops.md index af46c3f..88b0e24 100644 --- a/docs/reference/workbench/sessions/remote-desktops.md +++ b/docs/reference/workbench/sessions/remote-desktops.md @@ -3,6 +3,8 @@ title: Remote Desktops description: Remote desktop access to Vantage compute resources. --- + + Vantage provides remote desktop sessions (X2Go/Linux) for interactive GUI access to your compute resources. Launch a desktop session from the Workbench and connect from anywhere. ## Getting started diff --git a/docs/reference/workbench/sweeps/index.mdx b/docs/reference/workbench/sweeps/index.mdx index 9ac46d1..72b5926 100644 --- a/docs/reference/workbench/sweeps/index.mdx +++ b/docs/reference/workbench/sweeps/index.mdx @@ -17,6 +17,10 @@ A sweep is a hyperparameter-search experiment that runs many *trials*, each tria - **Presets:** pre-defined configurations for common search patterns. - **Trials:** individual parameter combinations within a sweep, each running as a training job. +## See also + +- [Training Jobs](/reference/workbench/training-jobs): each trial runs as a training job + ## Next steps - [Algorithms](/explanation/workbench/sweep-algorithms): the supported search strategies diff --git a/docs/reference/workbench/sweeps/presets.mdx b/docs/reference/workbench/sweeps/presets.mdx index 0dc7a90..de39300 100644 --- a/docs/reference/workbench/sweeps/presets.mdx +++ b/docs/reference/workbench/sweeps/presets.mdx @@ -8,7 +8,7 @@ description: Hyperparameter search presets for sweep configuration. Sweep presets are pre-defined configurations for common hyperparameter search patterns. They combine an algorithm with a set of parameter ranges so you can start a sweep without manually configuring every parameter. :::caution[Preview] -The Sweeps tab is in early access. Preset browsing is available in the UI, but sweep creation is API-only via the Vantage SDK. +Sweeps are in preview. Preset browsing and preset-based sweep creation are available in the UI. Sweeps can also be created programmatically via the Vantage SDK. ::: ## The presets list diff --git a/docs/reference/workbench/sweeps/trials.mdx b/docs/reference/workbench/sweeps/trials.mdx index a0071be..bc3b538 100644 --- a/docs/reference/workbench/sweeps/trials.mdx +++ b/docs/reference/workbench/sweeps/trials.mdx @@ -26,7 +26,11 @@ Click a trial to see its full parameter set, metric history, and logs. ## Best trial -The sweep detail page highlights the **best trial:** the one with the highest (or lowest, depending on the objective) metric value. This is the configuration you'd use for your production model. +The sweep detail page highlights the **best trial:** the one with the highest (or lowest, depending on the [objective direction](/explanation/workbench/sweep-algorithms)) metric value. This is the configuration you would use for your production model. + +## See also + +- [Training Jobs](/reference/workbench/training-jobs): each trial runs as a training job ## Next steps diff --git a/docs/reference/workbench/training-jobs/lifecycle.mdx b/docs/reference/workbench/training-jobs/lifecycle.mdx index 7fc0578..c50e5e8 100644 --- a/docs/reference/workbench/training-jobs/lifecycle.mdx +++ b/docs/reference/workbench/training-jobs/lifecycle.mdx @@ -18,5 +18,9 @@ Pending to Running to Succeeded/Failed and the actions at each phase. Lifecycle actions: Suspend, Resume, Retry (clones the job and re-runs from scratch), Delete. :::warning -If `active=N, ready
-## Create your first cluster. +## Create your first cluster Provision a new Slurm cluster: This step uses the `slurm-multipass` app, which provisions a Slurm cluster inside a Multipass VM. Make sure [Multipass is installed](https://multipass.run/install) before running this command. diff --git a/sidebars-main.js b/sidebars-main.js index f1cb9da..5a4d9eb 100644 --- a/sidebars-main.js +++ b/sidebars-main.js @@ -139,7 +139,7 @@ module.exports = { doc('how-to-guides/licenses/dsls/high-availability', 'High availability'), doc('how-to-guides/licenses/dsls/troubleshooting', 'Troubleshooting'), ]), - category('LM-X', 'how-to-guides/licenses/lmx/introduction', [ + category('LMX', 'how-to-guides/licenses/lmx/introduction', [ doc('how-to-guides/licenses/lmx/server-setup', 'Server setup'), doc('how-to-guides/licenses/lmx/vantage-managed-server-setup', 'Vantage-managed setup'), doc('how-to-guides/licenses/lmx/user-managed-server-setup', 'User-managed setup'), @@ -148,13 +148,14 @@ module.exports = { doc('how-to-guides/licenses/lmx/troubleshooting', 'Troubleshooting'), ]), category('LS-DYNA', 'how-to-guides/licenses/ls-dyna/introduction', [ + doc('how-to-guides/licenses/ls-dyna/server-setup', 'Server setup'), doc('how-to-guides/licenses/ls-dyna/vantage-managed-server-setup', 'Vantage-managed setup'), doc('how-to-guides/licenses/ls-dyna/user-managed-server-setup', 'User-managed setup'), doc('how-to-guides/licenses/ls-dyna/monitoring', 'Monitoring'), doc('how-to-guides/licenses/ls-dyna/high-availability', 'High availability'), doc('how-to-guides/licenses/ls-dyna/troubleshooting', 'Troubleshooting'), ]), - category('Olicense', 'how-to-guides/licenses/olicense/introduction', [ + category('OLicense', 'how-to-guides/licenses/olicense/introduction', [ doc('how-to-guides/licenses/olicense/server-setup', 'Server setup'), doc('how-to-guides/licenses/olicense/vantage-managed-server-setup', 'Vantage-managed setup'), doc('how-to-guides/licenses/olicense/user-managed-server-setup', 'User-managed setup'),