Codefresh Support Package

This project is designed to gather data from Codefresh Hybrid Runtimes OnPrem installation, and Open Source ArgoCD. It collects information about various Kubernetes resources such as Pods, Nodes, Configmaps, Services, and Events. For Pipelines and OnPrem we gather some informtion from the platform itself.

Prereqs

• A kubeconfig (KUBECONFIG or ~/.kube/config), or run inside the cluster.
  • Current Context must be the context of the cluster where the Codefresh is installed.
  • kubectl and tar are not required.
• Codefresh
  • CLI installed and configured.
  • Or the following ENV vars set.
    • CF_API_KEY: Codefresh API Token
    • CF_URL: URL of the platform (ex: https://g.codefresh.io)
  • Need an Account Admin Token for Pipelines Hybrid Runtime.
  • Need a System Admin Token for the OnPrem Installation.

Build Info

The tool is a NativeAOT .NET 10 binary with no runtime dependencies. Each platform binary is built natively on its own GitHub runner (see .github/workflows/release.yaml).

Build locally (requires the .NET 10 SDK and a C toolchain, i.e. Xcode command line tools or clang + zlib1g-dev):

./build.sh            # publishes for the current platform into ./bin/<rid>

Note: API calls to Codefresh ignore TLS certificate errors so that On-Prem installs with self-signed certificates work.

Usage

Main Help

Usage:   cf-support
Version: vX.X.X

Description:

  Tool to gather information for Codefresh Support

Options:

  -h, --help     - Show this help.
  -V, --version  - Show the version number for this program.

Commands:

  gitops     - Collect data for the Codefresh GitOps Runtime
  pipelines  - Collect data for the Codefresh Pipelines Runtime
  onprem     - Collect data for the Codefresh OnPrem Installation
  oss        - Collect data for the Open Source ArgoCD
  

macOS - arm64

# download and extract the latest binary
curl -L --output - https://github.com/codefresh-io/codefresh-support-package/releases/latest/download/cf-support_darwin_arm64.tar.gz | tar -zx -O cf-support_darwin_arm64 > cf-support

# set execution to binary
chmod +x cf-support

# run application
./cf-support

linux - arm64

# download and extract the latest binary
curl -L --output - https://github.com/codefresh-io/codefresh-support-package/releases/latest/download/cf-support_linux_arm64.tar.gz | tar -zx -O cf-support_linux_arm64 > cf-support

# set execution to binary
chmod +x cf-support

# run application
./cf-support

linux - amd64

# download and extract the latest binary
curl -L --output - https://github.com/codefresh-io/codefresh-support-package/releases/latest/download/cf-support_linux_amd64.tar.gz | tar -zx -O cf-support_linux_amd64 > cf-support

# set execution to binary
chmod +x cf-support

# run application
./cf-support

Windows - amd64 / arm64

1. Go the the Latest release.
2. Download the cf-support_windows_amd64.zip file (or cf-support_windows_arm64.zip on ARM devices) and extract the .exe
3. Run the .exe file via CMD or PowerShell
   • Do not use the ISE version of PowerShell

# CMD
C:\Users\Administrator\Downloads>cf-support_windows_amd64.exe

# PowerShell

PS C:\Users\Administrator\Downloads> .\cf-support_windows_amd64.exe

How to Release a New Version

1. Create a tag starting with v
2. Push tag to repo

git tag -a v1.0.0 -m "Release version 1.0.0"
git push origin v1.0.0