Skip to content

Latest commit

 

History

History
119 lines (89 loc) · 8.69 KB

10.5._Launch_a_Tool.md

File metadata and controls

119 lines (89 loc) · 8.69 KB

10.5. Launch a Tool

To launch a Tool you need to have EXECUTE permissions for it. For more information see 13. Permissions.

Launch the latest version

  1. To run an instance with a selected Tool navigate to the Tools tab and click the Tool name.

  2. Click the Run button in the top-right corner of the screen and the latest version with default settings will be launched (these are defined for Cloud Pipeline globally).
    CP_LaunchTool

  3. If you want to change settings, you shall click the arrow near the Run button → Custom settings.
    CP_LaunchTool

  4. Launch tool page will be opened.
    CP_LaunchTool
    Note: if Price type is set as "On-demand" - at the Launch page, an additional checkbox Auto pause appears:
    CP_LaunchTool
    This checkbox allows to enable automatic pausing on-demand instance if it is not used. Such behavior could be controlled by Administrators using a set of parameters at System Preferences (see here).

    Please note, this checkbox will not be displayed if any cluster is configured ("Static" or "Autoscaled").

  5. Define the parameters in the Exec environment, Advanced and Parameters tabs.

  6. Click the Launch button in the top-right corner of the screen.
    CP_LaunchTool
    Please note, that the current user can launch a tool only if he/his group has corresponding permissions on that tool (for more information see 13. Permissions), but the Launch button may be disabled also for one of the following reasons:

    • execution isn't allowed for specified docker image;
    • read operations aren't allowed for specified input or common path parameters;
    • write operations aren't allowed for specified output path parameters.

    In such cases, hover over the Launch button to view warning notification with a reason of a run forbiddance, e.g.:
    CP_LaunchTool

Launch particular Tool version

  1. To run a particular version click the Versions section.
  2. Select a version and click the Run button. The selected version with default settings will be launched (these are defined for Cloud Pipeline globally).
    CP_LaunchTool
  3. If you want to change settings, you shall click the arrow near the Run button → Custom settings.
    CP_LaunchTool
  4. Launch a tool page will be opened.
  5. Define the parameters.
  6. Click the "Launch" button.

Example 1

In this example, we will run the "centos-nomachine" Tool with custom settings: 20 Gb hard drive, 2 CPU cores, and 8 Gb RAM.
Note: "Start idle" box is ticked to allow SSH access to the running Tool. To learn more about interactive services see 15. Interactive services.
Click the Launch button in the top-right corner of the screen when all parameters are set.
CP_LaunchTool

After the Tool is launched you will be redirected to the Runs tab:

  1. Click the Log button to see run details after instance finishes initialization.
    CP_LaunchTool
  2. Click the SSH button in the Run logs page.
    CP_LaunchTool
  3. You will be redirected to the page with interactive shell session inside the Docker container. For example, we can list "/" directory content inside the container.
    CP_LaunchTool

Launch a Tool with "friendly" URL

User can specify a "Friendly URL" for persistent services. This produces endpoint URL in a more friendly/descriptive format: {cloud-pipeline_url}/friendly_url instead of {cloud-pipeline_url}/pipeline-XXXX-XXXX. It can be configured at a service launch time in the "Advanced" section of the Launch form.

Example 2

In this example we will configure a pretty URL for rstudio Tool.
Note: for do that, user account shall be registered within CP users catalog and granted READ & EXECUTE permissions for the rstudio Tool.

  1. Navigate to the Tools tab.
  2. In the Default registry select the library/rstudio Tool:
    CP_LaunchTool
  3. On opened page hover the "Run" button and click on appeared "Custom settings" point:
    CP_LaunchTool
  4. Click on "Advanced" control (a), input desired "Friendly URL" (b) (name shall be unique) and then click "Launch" button (c):
    CP_LaunchTool
  5. Open logs page of rstudio Tool, wait until tool successfully started.
  6. Click on hyperlink opposite "Endpoint" label:
    CP_LaunchTool
  7. In a new tab RStudio will be opened. Check, the URL will be in "pretty" format, that you inputted on step 4:
    CP_LaunchTool

Instance management

Instance management allows to set restrictions on instance types and price types for tool runs.

User shall have ROLE_ADMIN or to be an OWNER of the Tool to launch Instance management panel. For more information see 13. Permissions.

To open Instance management panel:

  1. Click CP_LaunchTool button in the left upper corner of the main tool page.
  2. Click "Instance management":
    CP_LaunchTool
  3. Such panel will be shown:
    CP_LaunchTool

On this panel you can specify some restrictions on allowed instance types and price types for launching tool.

Here you can specify:

Field Description Example
Allowed tool instance types mask This mask restrict for a tool allowed instance types. If you want for that tool only some of "large m5..." instances types will be able, mask would be m5*.large*
CP_LaunchTool
In that case, before launching tool, dropdown list of available node types will be look like this:
CP_LaunchTool
Allowed price types In this field you may restrict, what price types will be allowed for a user. If you want "On-demand" runs only for that tool will be able, select it in the dropdown list:
CP_LaunchTool
In that case, before launching tool, dropdown list of price types will be look like this:
CP_LaunchTool

To apply set restrictions for a tool click CP_LaunchTool button.

Setting restrictions on allowed instance types/price types is a convenient way to minimize a number of invalid configurations runs.
Such restrictions could be set not only for a tool, but on another levels too.
In CP platform next hierarchy is set for applying of inputted allowed instance types (sorted by priority):