Skip to content

Commit

Permalink
Update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
abhi18av authored Jan 31, 2022
1 parent 87f4d1f commit 4c96809
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## Tower Agent

Tower Agent allows Tower to launch pipelines on HPC clusters that do not allow direct access throw an SSH client.
Tower Agent allows Tower to launch pipelines on HPC clusters that do not allow direct access through an SSH client.

Tower Agent it's a standalone process that when executed in a node that can submit jobs to the cluster (i.e. the login node) it establishes an authenticated secure reverse connection with Tower, allowing Tower to submit and monitor new
Tower Agent is a standalone process that when executed in a node that can submit jobs to the cluster (i.e. the login node) it establishes an authenticated secure reverse connection with Tower, allowing Tower to submit and monitor new
jobs. The jobs are submitted on behalf of the same user that it's running the agent process.

### Installation
Expand All @@ -24,9 +24,9 @@ chmod +x ./tw-agent
### Quick start

Before running the Agent:
- You need to create a **personal access token** at Tower. See [here](https://help.tower.nf/api/overview/#authentication).
- At Tower you need to add new **Tower Agent** credentials in a workspace. See [here](https://help.tower.nf/credentials/overview/).
- When you create the credentials you'll get an **Agent Connection ID**. You can use that one or just set your own, the important is that you use the same connection ID at the workspace credentials and when you run the agent.
- You need to create a **personal access token** in Tower. See [here](https://help.tower.nf/api/overview/#authentication).
- On the Tower side, you need to add new **Tower Agent** credentials in a workspace. See [here](https://help.tower.nf/credentials/overview/).
- When you create the credentials you'll get an **Agent Connection ID**. You can use that one or just set your own, the important thing is that you use the same connection ID at the workspace credentials and when you run the agent.

Running the Agent:

Expand All @@ -38,9 +38,9 @@ export TOWER_ACCESS_TOKEN=<YOUR TOKEN>

### Tips

- If you are using an on premises Tower you can set the API url using `TOWER_API_ENDPOINT` environment variable or the `--url` option.
- If you are using the agent with Tower Enterprise (on-prem) you can set the API url using `TOWER_API_ENDPOINT` environment variable or the `--url` option.
- By default, the Agent uses the folder `~/work` at your home as working directory. You can change it using the `--work-dir` option.
- The work directory must exist before running the agent.
- The work directory **must** exist before running the agent.
- You can also change the work directory at Tower when you create a compute environment or pipeline.

### Usage
Expand Down

0 comments on commit 4c96809

Please sign in to comment.