@@ -7,18 +7,70 @@ This project is designed to gather data from Hybrid Runtimes for Codefresh SaaS
77-  ` kubectl ` 
88  -  Current Context must be the context of the cluster where the Codefresh is installed.
99-  Codefresh
10-   -  CLI installed and configured
11-   -  Or the following ENV vars set
10+   -  CLI installed and configured. 
11+   -  Or the following ENV vars set. 
1212    -  ` CF_API_KEY ` : Codefresh API Token
1313    -  ` CF_URL ` : URL of the platform (ex: ` https://g.codefresh.io ` )
14-   -  Need an Account Admin Token for Claasic Hybrid Runtime
14+   -  Need an Account Admin Token for Claasic Hybrid Runtime. 
1515  -  Need a System Admin Token for the OnPrem Installation.
1616-  Helm
17-   -  Version 3
18-   -  Used to get the helm release version of the installation
17+   -  Version 3.
18+   -  Used to get the helm release version of the installation.
19+ -  JQ
20+   -  Used only to get the latest version of the binary for * nix systems.
1921
2022## Usage  
2123
22- 1 .  Download the [ latest release] ( https://github.com/codefresh-support/codefresh-support-package/releases )  of the tool for your platform.
23- 1 .  Execute the file via the CLI and follow the prompts.
24- 1 .  Redact any sensitive contents and upload the package to the support ticket.
24+ ### macOS - arm64  
25+ 
26+ ``` shell 
27+ #  get the latest version or change to a specific version
28+ VERSION=$( curl --silent " https://api.github.com/repos/codefresh-support/codefresh-support-package/releases/latest"   |  jq -r " .tag_name" ) 
29+ 
30+ #  download and extract the binary
31+ curl -L --output - https://github.com/codefresh-support/codefresh-support-package/releases/download/$VERSION /cf-support_darwin_arm64.tar.gz |  tar zx -O cf-support
32+ 
33+ #  set execution to binary
34+ chmod +x cf-support
35+ 
36+ #  run application
37+ ./cf-support
38+ ``` 
39+ 
40+ ### macOS - x86_64  
41+ 
42+ ``` shell 
43+ #  get the latest version or change to a specific version
44+ VERSION=$( curl --silent " https://api.github.com/repos/codefresh-support/codefresh-support-package/releases/latest"   |  jq -r " .tag_name" ) 
45+ 
46+ #  download and extract the binary
47+ curl -L --output - https://github.com/codefresh-support/codefresh-support-package/releases/download/$VERSION /cf-support_darwin_x86_64.tar.gz |  tar zx -O cf-support
48+ 
49+ #  set execution to binary
50+ chmod +x cf-support
51+ 
52+ #  run application
53+ ./cf-support
54+ ``` 
55+ 
56+ ### linux - x86_64  
57+ 
58+ ``` shell 
59+ #  get the latest version or change to a specific version
60+ VERSION=$( curl --silent " https://api.github.com/repos/codefresh-support/codefresh-support-package/releases/latest"   |  jq -r " .tag_name" ) 
61+ 
62+ #  download and extract the binary
63+ curl -L --output - https://github.com/codefresh-support/codefresh-support-package/releases/download/$VERSION /cf-support_linux_x86_64.tar.gz |  tar zx -O cf-support
64+ 
65+ #  set execution to binary
66+ chmod +x cf-support
67+ 
68+ #  run application
69+ ./cf-support
70+ ``` 
71+ 
72+ ### Windows - x86_64  
73+ 
74+ 1 .  Go the the [ Latest] ( https://api.github.com/repos/codefresh-support/codefresh-support-package/releases/latest )  release.
75+ 1 .  Download the cf-support_windows_x86_64.zip file
76+ 1 .  Run the ` .exe `  file via CMD or PowerShell
0 commit comments