Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 4.13 KB

create-env.md

File metadata and controls

83 lines (53 loc) · 4.13 KB
Raw

Creating a new environment

To create an environment:

  1. In the left menu, press New Environment.

  2. In the Scope pane, choose a cluster, department, or project from the tree. The environment is assigned to that item and all its subsidiaries.

  3. Enter an Environment name.

  4. Enter the image URL path and an image pull policy.

  5. Choose a supported workload type. Configure this section based on the type of workload you expect to run in this environment. Choose from:

    • Standard—use for running workloads on a single node.
    • Distributed—use for running distributed workloads on multiple nodes.

    Then choose the workload that can use the environment:

    • Workspace
    • Training
    • Inference

    If you selected Inference, in the endpoint pane, select a Protocol from the dropdown, then enter the Container port.

  6. Select a tool from the list. You can add multiple tools by pressing + Tool. Selecting a tool is optional.

    Tools can be:

    • Different applications such as Code editor IDEs (for example, VS Code), Experiment tracking (for example, Weight and Biases), visualization tools (for example, Tensor Board), and more.
    • Open source tools (for example, Jupyter notebook) or commercial 3rd party tools (for example,. MATLAB)

    !!! Note Tool configuration is not supported with Inference environments.

    It is also possible to set up a custom tool used by the organization.

    For each tool, you must set the type of connection interface and port. If not set, default values are provided. The supported connection types are:

    • External URL: This connection type allows you to connect to your tool either by inserting a custom URL or having one generated for you. Either way, the URL should be unique per workspace as many workspaces may use the same environment. If the URL type was set to custom, the URL will be requested from the Researcher upon creating the workspace.
    • External node port: A NodePort exposes your application externally on every host of the cluster, access the tool using http://<HOST_IP>:<NODEPORT> (for example, http://203.0.113.20:30556).

    !!! Note Selecting a tool requires a configuration to be up and running.

    To configure a tool:

    • The container image needs to support the tool.
    • The administrator must configure a DNS record and certificate. For more information, see Workspaces configuration.

  7. Configure runtime settings with:

    1. Commands and arguments&mdash;visible, but not editable in the workspace creation form.
2. Environment variables&mdash;visible and editable in the workspace creation form.
3. Set the container's working directory.

    !!! Note The value of an environment variable can remain empty for the researcher to fill in when creating a workspace.

  8. Configure the security settings from:

    1. Settings in the image&mdash;security settings that come with the image file. 
2. Custom settings:

   1. User ID.
   2. Group ID.
   3. Supplementary Groups.
   4. Values modification settings.

3. Add linux capabilities.

Download Environments Table

You can download the Environments table to a CSV file. Downloading a CSV can provide a snapshot history of your environments over the course of time, and help with compliance tracking. All the columns that are selected (displayed) in the table will be downloaded to the file.

Use the Cluster filter at the top of the table to see environments that are assigned to specific clusters.

!!! Note The cluster filter will be in the top bar when there are clusters that are installed with version 2.16 or lower.

Use the Add filter to add additional filters to the table.

To download the Environments table to a CSV:

  1. In the left menu, press Environments.
  2. From the Columns icon, select the columns you would like to have displayed in the table.
  3. Click on the ellipsis labeled More, and download the CSV.