gopaddle User Guide
  • 👋Welcome to gopaddle
  • Overview
    • 💡Getting Started
    • Register a Cluster
      • Register Rancher Prime - RKE2
      • Register K3S
      • Register MicroK8s
      • Register Kind
      • Register minikube
      • Register Kubeadm Cluster
      • Register AWS EKS Cluster
        • EKS Cluster with public or public/private access point
        • EKS Cluster with private access endpoint and a bastion host
        • Validate Cluster Connectivity
      • Register Azure AKS Cluster
      • Register Google GKE Cluster
      • Register Huawei Cloud Container Engine
    • Register GitHub Account
    • Register Jira Account
    • Register ChatGPT Assistant
    • 💻Kubernetes IDE
      • Filters
      • Editor
      • Flat vs Tree View
      • Developer Tools
    • 🙋AI Assistant
      • Chat with AI
      • Raise a Jira Ticket from Chat Window
      • Create Runbook from Chat Window
    • 📖Runbook Hub
      • Create Runbook Hub
      • Attach Runbook Hub to Cluster
      • Enhancing contents of Runbooks with AI
      • Detach Runbook Hub from Cluster
      • Syncing Runbook Hub with GitHub
      • Delete Runbook / Runbook Hub
    • ⏱️Installing Community Edition
      • MicroK8s Addon
        • On Ubuntu
        • On MacOS
      • Docker Desktop
      • SUSE Rancher Prime
      • Digital Ocean
      • Akamai Linode
      • Kind Cluster
      • Helm
      • Docker Compose
      • Accessing gopaddle UI
    • 📈Improving performance of resource discovery
    • Provision new Cluster
      • Register Cloud Account
        • AWS
          • Quickstart AWS Setup
          • IAM Access Policies
          • AWS Setup Script
        • Azure
          • Create Azure Application
          • Register Azure Cloud Authenticator
          • Register Azure Account
        • Google
      • Provision Clusters on Cloud
        • AWS EKS
          • AWS EKS Reference Architecture
          • Adding an AWS IAM Role (EKS Master / Node Pool)
          • Public EKS Cluster
          • All Private EKS Cluster (beta)
          • Creating a Node Pool
        • Azure AKS
          • Creating a Node Pool
          • Enable Public IP Node Access for Azure Deployments
          • VMSS Autoscaling Rules
        • Google GKE
          • Creating a Node Pool
  • 🔎Troubleshooting
    • Cluster Resource View Issues
      • Network Error ! ServerError: Response not successful: Received status code 503
      • Network Error ! TypeError: Failed to fetch
      • Network Error ! ServerParseError: Unexpected token 'j', "json: erro"... is not valid JSON
      • Updating Labels and Annotations does not get reflected in resources list
      • Filtered resources are not fully listed
    • Runbook Issues
      • Deleting a runbook from .gp.yaml does not detach annotation in resources
      • Deleting a Code Account from gopaddle UI does not detach annotation in resources
    • Jira Issues
      • Creating, Updating or Appending a Jira issue fails with error INVALID_INPUT
    • EKS Issues
    • Deployment Issues
    • Node Issues
    • Huawei Issues
Powered by GitBook
On this page
  • Prerequisite to test Runbooks with a sample application
  • Steps to attach Hub to a Cluster
  1. Overview
  2. Runbook Hub

Attach Runbook Hub to Cluster

PreviousCreate Runbook HubNextEnhancing contents of Runbooks with AI

Last updated 1 year ago

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 to learn more about initializing a repository as a Hub.

b) 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
  1. Navigate to the Clusters section in the left navigation panel and click on the cluster name to view the cluster

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

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

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

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

List of Runbook Hubs in Cluster Page
View Filtered Resources with Runbooks
📖
Page cover image
runbook hub section
Register the source control account
Cluster View Runbook Attached to Resource