GitHub Node

Once a Connection Manager has been set up, you can add nodes for Agentless scanning and monitoring. Cloudhouse Guardian (Guardian) supports two types of GitHub nodes: an organization and a repository node. Once you have added a GitHub node, you can secure your GitHub account, see Secure your GitHub Account for more information. The following topic describes how to add a GitHub node to your instance for monitoring.

Dependencies

To add a GitHub node, the following dependencies must be met:

  • Windows Connection Manager – Set up in Guardian. For more information, see Windows Connection Manager.

  • GitHub Account – Set up with access to the GitHub organization and repositories to be scanned.

  • GitHub API Token – To generate or access personal access tokens.

Add a GitHub Organization Node

Adding a GitHub organization node to your Guardian instance lets you monitor and track the configuration of projects within that organization.

To add a GitHub Organization node for Agentless scanning, complete the following steps:

  1. In the Guardian web application, navigate to the Add Nodes tab (Inventory > Add Nodes). The Add Nodes page is displayed.

  2. Select 'GitHub Organization' from the list of node types and click the Go Agentless button to proceed. The Connect Agentlessly to GitHub Organization page is displayed.

  3. Here, complete the following options:

    Option

    Description
    Connection Manager group drop-down list The Connection Manager group that is responsible for scanning your GitHub node. Select a Connection Manager group from the drop-down list.
    Node Name field

    The name of the node. The value you enter here will be used as the display name in Guardian.
    GitHub organization URL field

    The base URL of the GitHub organization you want to connect to. For example, 'https://www.github.com/cloudhousetech'.
    GitHub API token field

    The personal access token required to connect to the GitHub organization. This can be found and generated via the Personal Access Tokens page in GitHub Settings.

  4. Once you've completed the above options click Scan Node to add the GitHub organization node to your Guardian instance.

Now, Guardian performs an initial scan of the node. You can wait on this page for the scan to finish, at which point you will see a View Scan button. To view the results of this initial scan, click View Scan. However, you can also navigate elsewhere while Guardian performs its initial scan of the node. You can then view the status of the scan on the Job History page (Inventory > Job History). For more information on what to do next after adding a node, see below.

Add a GitHub Repository Node

Adding a GitHub repository node to your Guardian instance lets you monitor and track the configuration of code, files, and settings within that repository.

  1. In the Guardian web application, navigate to the Add Nodes tab (Inventory > Add Nodes). The Add Nodes page is displayed.

  2. Select 'GitHub Repository' from the list of node types and click the Go Agentless button to proceed. The Connect Agentlessly to GitHub Repository page is displayed.

  3. Here, complete the following options:

    Option

    Description
    Connection Manager group drop-down list

    The Connection Manager group that is responsible for scanning your GitHub node. Select a Connection Manager group from the drop-down list.
    Node Name field

    The name of the node. The value you enter here will be used as the display name in Guardian.
    GitHub repository URL field

    The base URL of the GitHub repository you want to connect to. For example, 'https://www.github.com/cloudhousetech/content'.
    GitHub API token field

    The personal access token required to connect to the GitHub repository. This can be found and generated via the Personal Access Tokens page in GitHub Settings.

  4. Once you have set the correct values for each of the options displayed, click Scan Node to add the GitHub repository node to your Guardian instance.

Now, Guardian performs an initial scan of the node. You can wait on this page for the scan to finish, at which point you will see a View Scan button. To view the results of this initial scan, click View Scan. However, you can also navigate elsewhere while Guardian performs its initial scan of the node. You can then view the status of the scan on the Job History page (Inventory > Job History). For more information on what to do next after adding a node, see below.

Next Steps

Once you've added nodes to Guardian, there are a few next steps you can take to get the most out of Guardian and the data it collects. Refer to the topics below for more information on where to go from here.

  • Node Scan Results – View and filter the data collected by Guardian every time a node is scanned.

  • Node Groups – Group nodes together based on similar properties like node type, location, and more.

  • Scan Options – Customize what is scanned on a given node during a node scan.

  • Configuration Differencing – View differences between two nodes, a group of nodes, two scans of the same node, and more.

  • Policies – Define expected configuration states and apply them to nodes or node groups.

  • Integrations – Bring together different systems, applications, or components to work as a unified view and perform different tasks.