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
  • Step 1 - Create a new private repository
  • Step 2 - Create a GitHub Access Token
  • Step 3 - Register Source Control Account
  1. Overview

Register GitHub Account

This page provides a step-by-step guide on how to register your GitHub account with our platform, enabling you to access and manage runbook hubs for context-driven troubleshooting documentation

PreviousRegister Huawei Cloud Container EngineNextRegister Jira Account

Last updated 1 year ago

Registering a GitHub account with gopaddle allows you to unlock the full potential of runbook hubs for efficient, context-aware troubleshooting. Discover existing hubs or easily create new ones for streamlined documentation and faster issue resolution. Follow the steps to create a repository in GitHub account and register the GitHub account

Step 1 - Create a new private repository

Create a new private repository (say demo-hub) in a GitHub account that would act as a Runbook Hub.

Step 2 - Create a GitHub Access Token

Create an access token in the GitHub account with permission to read the repository.

  1. Select the user profile in GitHub account and click on Settings

  2. In the Settings page, select Developer Settings in the left panel.

  3. Choose Personal access tokens and Tokens (classic)

  1. Select Generate new token and Generate new token (classic)

  2. Add a note “gopaddle runbook access” to the token for future reference

  3. Under Select scopes, choose repo.

  1. Copy the token

Step 3 - Register Source Control Account

  1. In the gopaddle UI, in the left panel under Settings, choose Code and then Accounts

  2. Choose Register Source Control Account

  3. Select Token and provide the GitHub token

  1. Click Register: This will register and discover any pre-existing runbook hubs (ie., repositories with .gp.yaml). If there are no pre-existing hubs, a new hub can be created at a later stage.

Page cover image
Register GitHub Account in gopaddle