Skip to content

Draft: Add cloud-connector script for checking CC features

Nikola Milojevic requested to merge cloud_connector_script into master

What does this MR do and why?

if we want to access some specific data like available token scopes and purchased add-ons, we would need access to Rails Runner.

We could create and store the script in bin/cloud_connector inside the monolith. The customer could ssh to the instance and run this script directly, or download and run it.

 gitlab-rails runner ./bin/cloud_connector --help           
   Usage: ./healthcheck
        --debug                      Enable debug mode
        --output-file FILE           Write a report to FILE
        --username USERNAME          Provide a username to test seat assignments
        --skip [CHECK]               Skip specific check (options: access_data, token, license, host, features, end_to_end)
  • If run without --debug mode, it will work similarly to our health-check probes.
  gitlab-rails runner ./bin/cloud_connector

image

  • With --debug mode, it would provide more debug information for us. The customer can also use the --output-file option, to save the report to a file, that he can send us.
  • If --username is provided, the script will also check add-on seat assignments when checking feature availability.
  gitlab-rails runner ./bin/cloud_connector --debug --username 'root'

image

@bprescott do you have experience with how customer usually do this? I think with the script delivered in /bin folder, both customers, and developers could benefit from debugging cloud connector configuration and their access to AI features. For older instances, we can write instructions on how customers can download the script, or simply send the script to them.

Add cloud-connector script for checking CC features

  • Add specs for cloud connector script

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

Edited by Nikola Milojevic

Merge request reports