Attach Runbook Hub to Cluster

A hub can be attached to one or more clusters. When a hub is attached to a cluster, gopaddle filters the Kubernetes resources and events in the cluster matching the selectors across all the runbooks within the hub. The filtered resources and events are then annotated with the runbook information.

Prerequisite to test Runbooks with a sample application

To test the runbook functionality,

a) create a sample repository in your GitHub Account and initialize a .gp.yaml file. Check the runbook hub section to learn more about initializing a repository as a Hub.

b) Register the source control account and make sure the Runbook Hub is discovered.

c) Deploy the below sample application such that we have a application that matches the selectors in the Runbook Hub.

Sample Application to create an Event

For the purpose of testing, a sample Pod with ImagePullBackOff can be deployed by applying the yaml below:

kubectl apply -f - <<EOF
apiVersion: v1
kind: Namespace
metadata:
  name: demo-1
---
apiVersion: v1
kind: Pod
metadata:
  name: image-pull-failure-pod
  namespace: demo-1
  labels:
    app: image-pull-failure-pod
spec:
  containers:
  - name: image-error-container
image: non-existent-image:latest # This image intentionally does not exist
EOF

Steps to attach Hub to a Cluster

1. In the left navigation panel, select Runbook Hubs.

2. Click on a Runbook Hub to view the Runbook Hub

3. Click on the attach icon under the Clusters section
4. In the popup choose the localhost cluster and select Attach

Select the cluster to attach

5. Navigate to the Clusters section in the left navigation panel and click on the cluster name to view the cluster

6. All the runbook hubs associated with the cluster can be viewed under the Runbook Hubs section.

List of Runbook Hubs in Cluster Page

6. Click on View -> Resources to list all the resources discovered under the cluster

7. Choose the List filtered resources with runbooks to view the resources tagged with runbooks. The demo pending Pod gets listed with a runbook icon.

View Filtered Resources with Runbooks

8. Click on the runbook icon to view the runbook.

Cluster View Runbook Attached to Resource