Skip to content

Commit

Permalink
Merge pull request #6 from ParaToolsInc/oddc-cli
Browse files Browse the repository at this point in the history
Added subsections. Expanded on ODDC CLI access

Fixes #5
  • Loading branch information
zbeekman authored Jul 10, 2024
2 parents c0a46b8 + 3839eef commit 0d7a124
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions docs/ODDC/getting-started-ODDC.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,28 @@ This tutorial assumes you have access to a functioning ODDC server, installed an

## Tutorial

###
Enter the URL for your ODDC web portal instance in a web browser and log in with the credentials you created during configuration. Mouse over the menu on the left and select [Cluster Manager][2].
### Login
Enter the URL for your ODDC web portal instance in a web browser and log in with the credentials you created during configuration.

### Create/Launch Cluster
Mouse over the menu on the left and select [Cluster Manager][2].

You can create or import a new cluster using the '+' button in the upper right. Once your cluster is configured hit the ellipsis '...' on the right side of your cluster entry and select the deploy option. The portal will display the progress of the cluster initialization and let you know when the cluster is available.

Once your cluster has been launched you can issue jobs from the Job Manager, available via the menu on the right. To log into the cluster you can find the cluster's public IP address at the end of the startup log, available from the cluster's ellipsis menu while the cluster is active. Alternatively you can ssh to ODDC CLI and log in like `oddc cluster:ssh <cluster-name>`
### Launch Jobs

Once your cluster has been launched you can create and issue jobs from the Job Manager, available via the menu on the right.

### Log In

To log into the cluster you can find the cluster's public IP address at the end of the startup log, available from the cluster's ellipsis menu while the cluster is active.

Alternatively you can ssh to the ODDC server and use the ODDC CLI to log in. To do this you must first configure a VPN to access the ODDC server. We recommend [WireGuard][3]. Once WireGuard is installed and configured with your authentication credentials and the address of the ODDC server you can ssh to the server. From the ODDC server you can log in to your cluster like `oddc cluster:ssh <cluster-name>` Add the `--admin` flag for access to sudo privileges on the cluster.

### Cleanup

When you are finished de-allocate the cluster by entering its ellipsis menu and selecting destroy. The portal will show the destruction's progress and indicate when it is complete. Once the cluster has been deactivate it may be deleted entirely via the delete option in the ellipsis menu or kept in your cluster list for a new instance to be initialized later.

[1]: https://support.adaptivecomputing.com/wp-content/uploads/2024/06/HPCCloudOnDemandDataCenterUserGuide771.pdf
[2]: https://support.adaptivecomputing.com/wp-content/uploads/2024/06/HPCCloudOnDemandDataCenterUserGuide771.pdf#%5B%7B%22num%22%3A28%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22XYZ%22%7D%2C88.5%2C669.75%2C0%5D
[2]: https://support.adaptivecomputing.com/wp-content/uploads/2024/06/HPCCloudOnDemandDataCenterUserGuide771.pdf#%5B%7B%22num%22%3A28%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22XYZ%22%7D%2C88.5%2C669.75%2C0%5D
[3]: https://www.wireguard.com/

0 comments on commit 0d7a124

Please sign in to comment.