Skip to content

cleanup runner-install #1666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gschueler merged 1 commit into from
May 28, 2025
Merged

cleanup runner-install #1666

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
288 changes: 0 additions & 288 deletions docs/administration/runner/runner-installation/runner-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,55 +8,6 @@ For most use-cases, the steps outlined in the [Creating Runner](/administration/

However, there are some advanced installation options that you may want to consider depending on your environment and requirements.

[//]: # (Once you have [created and downloaded a Runner](/administration/runner/runner-installation/creating-runners.md), upload the binary to the environment where it will run and use the following the installation instructions to launch the runner.)

[//]: # (### Pre-Requisites)

[//]: # ()
[//]: # (- Runners can be installed on Windows, Linux or in containers.)

[//]: # ( - The operating systems that we officially support for the Runner are listed [here](/administration/install/system-requirements.md).)

[//]: # ( - Note that the Runner can be installed on a *different* operating system than the self-hosted cluster.)

[//]: # (- Java 11 or Java 17 JRE installed on the Runner's host.)

[//]: # ()
[//]: # (- The Runner binary size is 164MB.)

[//]: # ()
[//]: # (#### Resource Allocation)

[//]: # ()
[//]: # (If setting up Enterprise Runners on virtualized environments, here are baseline recommendations. These are _**general**_ guidelines and the actual resource requirements may vary based on the workload and the number of concurrent executions. It is recommended to monitor the Runner's performance - such as CPU, Memory, and Network Latency - and adjust the resources accordingly.)

[//]: # ()
[//]: # ( | | **Minimum** | **Medium** | **Large** |)

[//]: # ( |---------------|-------------|------------|-----------|)

[//]: # ( | **vCPU** | 4 cores | 8 cores | 12 cores |)

[//]: # ( | **Memory** | 8 GiB | 16 GiB | 32 GiB |)

[//]: # ( | **Java Heap** | 6 GiB | 12 GiB | 24 GiB |)

[//]: # ( | **Storage** | 40 GiB | 40 GiB | 40 GiB |)

[//]: # ()
[//]: # (### Basic Installation steps)

[//]: # ()
[//]: # (1. Copy the Runner JAR file that was saved when the Runner was created to the server and directory where it will run.)

[//]: # (1. Execute `java -jar runner_filename.jar` to start the service.)

[//]: # (1. Connection can be confirmed on the Runner Management page on the Last Checkin line. If there are errors in the output resolve those using troubleshooting steps below: )

[//]: # (1. Runner Logs are located in the ./runner/logs folder under the folder where the jar was executed from. The runner.log file contains operational and important messages about the runner. operations.log tracks an operation starts and if it succeeds or fails. )

[//]: # (Read more about [Runner logging configuration](/administration/runner/runner-management/runner-logging.md) to customize logging.)

## Linux Service for the Runner
The Runner can be installed as a `systemd` service on Linux systems.

Expand Down Expand Up @@ -211,239 +162,6 @@ docker run -it \
rundeckpro/runner:{{ $rundeckVersion }}
```

[//]: # (## Deploying Runners in Kubernetes)

[//]: # ()
[//]: # (These instructions will guide how to install a Runner in Kubernetes.)

[//]: # ()
[//]: # (1. [Create an API Token](/manual/10-user.md#user-api-tokens) or use an existing API Token to download a new Runner via API using the following **`curl`** request. Be sure to replace **`[URL]`** and **`[ApiToken]`** **`[ProjectName]`** with your Runbook Automation instance URL and API Token respectively:)

[//]: # ( :::tip Heads Up!)

[//]: # ( Be sure to give each Runner a unique name. This is how you will identify one Runner from another in the platform.)

[//]: # ( :::)

[//]: # ( ```)

[//]: # ( curl --location --request POST 'https://[URL]/api/42/runnerManagement/runners' \)

[//]: # ( --header 'Accept: application/json' \)

[//]: # ( --header 'X-Rundeck-Auth-Token: [ApiToken]' \)

[//]: # ( --header 'Content-Type: application/json' \)

[//]: # ( --data-raw '{)

[//]: # ( "name": "Kubernetes Runner",)

[//]: # ( "description": "Kubernetes runner",)

[//]: # ( "assignedProjects": {)

[//]: # ( "[ProjectName]": ".*",)

[//]: # ( },)

[//]: # ( "tagNames": "kubernetes")

[//]: # ( }')

[//]: # ( ```)

[//]: # (2. The response will provide a **`runnerId`** and **`token`**. Here is an example output:)

[//]: # ( ```)

[//]: # ( {"description":"Kubernetes runner","downloadTk":"d98d21bb-not-real-token-85bcf618ffd0",)

[//]: # ( "name":"Kubernetes Runner","projectAssociations":{"Kubernetes":".*"},)

[//]: # ( "runnerId":"ad45e0c6-not-real-runner-044b4624fff3","token":"NopObWnk1MnotRealTokenvfwJzPTd"})

[//]: # ( ```)

[//]: # (3. (Optional) Verify that the runner was created as intended by navigating to **System Menu** (upper-right gear icon) -> **Runner Management** and see if the Runner is listed.)

[//]: # (4. (Optional) Create a Kubernetes namespace for the Runner: **`kubectl create namespace rundeck`**)

[//]: # (5. Create a deployment YAML for the Runner. Be sure to replace **`[namespace]`**, **`[RUNNER ID]`**, **`[TOKEN]`**, and **`[INSTANCE-SUBDOMAIN]`**:)

[//]: # (```)

[//]: # (apiVersion: v1)

[//]: # (kind: Pod)

[//]: # (metadata:)

[//]: # ( namespace: [namespace])

[//]: # ( name: rundeck-runner)

[//]: # ( labels:)

[//]: # ( app: rundeck-runner)

[//]: # (spec:)

[//]: # ( containers:)

[//]: # ( - image: rundeckpro/runner)

[//]: # ( imagePullPolicy: IfNotPresent)

[//]: # ( name: rundeck-runner)

[//]: # ( env:)

[//]: # ( - name: RUNNER_RUNDECK_CLIENT_ID)

[//]: # ( value: "[RUNNER ID]")

[//]: # ( - name: RUNNER_RUNDECK_SERVER_TOKEN)

[//]: # ( value: "[TOKEN]")

[//]: # ( - name: RUNNER_RUNDECK_SERVER_URL)

[//]: # ( value: "https://[INSTANCE-SUBDOMAIN].runbook.pagerduty.cloud")

[//]: # ( lifecycle:)

[//]: # ( postStart:)

[//]: # ( exec:)

[//]: # ( command:)

[//]: # ( - /bin/sh)

[//]: # ( - -c)

[//]: # ( - touch this_is_from_rundeck_runner)

[//]: # ( restartPolicy: Always)

[//]: # (```)

[//]: # (6. Create the deployment: **`kubectl apply -f deployment.yml`**.)

[//]: # (7. Confirm that the Runner was deployed successfully: **`kubectl logs -f rundeck-runner --namespace=[NAMESPACE]`**)

[//]: # (8. Verify that the Runner is communicating with Runbook Automation correctly by looking in the **Status** column on the Runner Management page:)

[//]: # ( ![Runner installed correctly](/assets/img/runner-installed-k8s.png))

[//]: # (:::tip Tip: Multiple Pods for Scalability)

[//]: # ( Multiple replicas of the Runner container can be associated with a single deployment, though they will appear as a single Runner in Runbook Automation. )

[//]: # ( This is useful for horizontally scaling the Runner. Here is an example deployment yaml where 2 replicas are used:)

[//]: # (```)

[//]: # (apiVersion: apps/v1)

[//]: # (kind: Deployment)

[//]: # (metadata:)

[//]: # ( namespace: rundeck)

[//]: # ( name: rundeck-runner)

[//]: # ( labels:)

[//]: # ( app: rundeck-runner)

[//]: # (spec:)

[//]: # ( replicas: 2)

[//]: # ( selector:)

[//]: # ( matchLabels:)

[//]: # ( app: runner)

[//]: # (template:)

[//]: # ( metadata:)

[//]: # ( labels:)

[//]: # ( app: runner)

[//]: # ( spec:)

[//]: # ( containers:)

[//]: # ( - image: rundeckpro/runner)

[//]: # ( imagePullPolicy: IfNotPresent)

[//]: # ( name: rundeck-runner)

[//]: # ( env:)

[//]: # ( - name: RUNNER_RUNDECK_CLIENT_ID)

[//]: # ( value: "[RUNNER ID]")

[//]: # ( - name: RUNNER_RUNDECK_SERVER_TOKEN)

[//]: # ( value: "[TOKEN]")

[//]: # ( - name: RUNNER_RUNDECK_SERVER_URL)

[//]: # ( value: "[URL]")

[//]: # (```)

[//]: # (Verify that the pods were deployed successfully: )

[//]: # (:::)

[//]: # ()
[//]: # (## Using the Runner on Windows)

[//]: # ()
[//]: # (The “Runner Management” menu will appear on under the “System” settings:)

[//]: # ()
[//]: # (![Runner Architecture](/assets/img/runner-management.png))

[//]: # ()
[//]: # (If you are installing a Runner on a Windows OS as localhost node, you have to specify the “OS Family” setting as “windows”.)

[//]: # ()
[//]: # (- Choose related to the project.)

[//]: # (- Go to the left side bar menu and choose "EDIT NODES".)

[//]: # (- Click on "Resources" tab.)

[//]: # (- Click on "Edit" on the local node.)

[//]: # (- On the field "OS Family" set "windows".)

[//]: # ()
[//]: # (![Runner Architecture](/assets/img/runner-edit-nodes.png))

[//]: # ()
[//]: # (![Runner Architecture](/assets/img/runner-resource-tab.png))

[//]: # ()
[//]: # (![Runner Architecture](/assets/img/runner-edit-local.png))

[//]: # ()
[//]: # (![Runner Architecture](/assets/img/runner-os-family.png))

[//]: # ()
[//]: # (Powershell script steps are fully supported on the Runner. Commands that run through the cmd.exe shell are not supported at the moment.)

## Secure the Runner Deployment

Expand All @@ -467,9 +185,3 @@ RUNNER_RUNDECK_SERVER_TOKEN=8FpagGtalnxnv1fmllyYYz4quhNHpBR8
RUNNER_RUNDECK_SERVER_URL=http://192.168.100.2:4440/
```

[//]: # (## Removing Runners)

[//]: # ()
[//]: # (Before removing a Runner it is advisable to verify that there are other active runners tagged with the same tags. This will ensure that jobs that are configured with those tags have at least one available Remote runner to carry out the tasks for the job.)

[//]: # ()
Loading