DevFW-CICD/garm
15
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

Add endpoint option to all relevant commands

Browse source 
In case of ambiguity when using the name of a repo, org or enterprise,
an --endpoint flag can be used to uniquely identify an entity against
an endpoint.

Signed-off-by: Gabriel Adrian Samfira <gsamfira@cloudbasesolutions.com>
This commit is contained in:
Gabriel Adrian Samfira 2025-06-21 16:53:41 +00:00
parent e92b2c1111
commit 808af82e0d
6 changed files with 71 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

10
cmd/garm-cli/cmd/enterprise.go
View file

@ -113,7 +113,7 @@ var enterpriseShowCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
enterpriseID, err := resolveEnterprise(args[0])
enterpriseID, err := resolveEnterprise(args[0], enterpriseEndpoint)
if err != nil {
return err
}
@ -146,7 +146,7 @@ var enterpriseDeleteCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
enterpriseID, err := resolveEnterprise(args[0])
enterpriseID, err := resolveEnterprise(args[0], enterpriseEndpoint)
if err != nil {
return err
}
@ -177,7 +177,7 @@ var enterpriseUpdateCmd = &cobra.Command{
if len(args) > 1 {
return fmt.Errorf("too many arguments")
}
enterpriseID, err := resolveEnterprise(args[0])
enterpriseID, err := resolveEnterprise(args[0], enterpriseEndpoint)
if err != nil {
return err
}
@ -213,6 +213,10 @@ func init() {
enterpriseUpdateCmd.Flags().StringVar(&enterpriseWebhookSecret, "webhook-secret", "", "The webhook secret for this enterprise")
enterpriseUpdateCmd.Flags().StringVar(&enterpriseCreds, "credentials", "", "Credentials name. See credentials list.")
enterpriseUpdateCmd.Flags().StringVar(&poolBalancerType, "pool-balancer-type", "", "The balancing strategy to use when creating runners in pools matching requested labels.")
enterpriseUpdateCmd.Flags().StringVar(&enterpriseEndpoint, "endpoint", "", "When using the name of the enterprise, the endpoint must be specified when multiple enterprises with the same name exist.")
enterpriseDeleteCmd.Flags().StringVar(&enterpriseEndpoint, "endpoint", "", "When using the name of the enterprise, the endpoint must be specified when multiple enterprises with the same name exist.")
enterpriseShowCmd.Flags().StringVar(&enterpriseEndpoint, "endpoint", "", "When using the name of the enterprise, the endpoint must be specified when multiple enterprises with the same name exist.")
enterpriseCmd.AddCommand(
enterpriseListCmd,

22
cmd/garm-cli/cmd/organization.go
View file

@ -76,7 +76,7 @@ var orgWebhookInstallCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
orgID, err := resolveOrganization(args[0])
orgID, err := resolveOrganization(args[0], orgEndpoint)
if err != nil {
return err
}
@ -110,7 +110,7 @@ var orgHookInfoShowCmd = &cobra.Command{
if len(args) > 1 {
return fmt.Errorf("too many arguments")
}
orgID, err := resolveOrganization(args[0])
orgID, err := resolveOrganization(args[0], orgEndpoint)
if err != nil {
return err
}
@ -142,7 +142,7 @@ var orgWebhookUninstallCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
orgID, err := resolveOrganization(args[0])
orgID, err := resolveOrganization(args[0], orgEndpoint)
if err != nil {
return err
}
@ -230,7 +230,7 @@ var orgUpdateCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
orgID, err := resolveOrganization(args[0])
orgID, err := resolveOrganization(args[0], orgEndpoint)
if err != nil {
return err
}
@ -290,7 +290,7 @@ var orgShowCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
orgID, err := resolveOrganization(args[0])
orgID, err := resolveOrganization(args[0], orgEndpoint)
if err != nil {
return err
}
@ -323,7 +323,7 @@ var orgDeleteCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
orgID, err := resolveOrganization(args[0])
orgID, err := resolveOrganization(args[0], orgEndpoint)
if err != nil {
return err
}
@ -357,12 +357,22 @@ func init() {
orgAddCmd.MarkFlagRequired("name") //nolint
orgDeleteCmd.Flags().BoolVar(&keepOrgWebhook, "keep-webhook", false, "Do not delete any existing webhook when removing the organization from GARM.")
orgDeleteCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "When using the name of the org, the endpoint must be specified when multiple organizations with the same name exist.")
orgShowCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "When using the name of the org, the endpoint must be specified when multiple organizations with the same name exist.")
orgUpdateCmd.Flags().StringVar(&orgWebhookSecret, "webhook-secret", "", "The webhook secret for this organization")
orgUpdateCmd.Flags().StringVar(&orgCreds, "credentials", "", "Credentials name. See credentials list.")
orgUpdateCmd.Flags().StringVar(&poolBalancerType, "pool-balancer-type", "", "The balancing strategy to use when creating runners in pools matching requested labels.")
orgUpdateCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "When using the name of the org, the endpoint must be specified when multiple organizations with the same name exist.")
orgWebhookInstallCmd.Flags().BoolVar(&insecureOrgWebhook, "insecure", false, "Ignore self signed certificate errors.")
orgWebhookInstallCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "When using the name of the org, the endpoint must be specified when multiple organizations with the same name exist.")
orgWebhookUninstallCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "When using the name of the org, the endpoint must be specified when multiple organizations with the same name exist.")
orgHookInfoShowCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "When using the name of the org, the endpoint must be specified when multiple organizations with the same name exist.")
orgWebhookCmd.AddCommand(
orgWebhookInstallCmd,
orgWebhookUninstallCmd,

16
cmd/garm-cli/cmd/pool.go
View file

@ -105,7 +105,7 @@ Example:
switch len(args) {
case 0:
if cmd.Flags().Changed("repo") {
poolRepository, err = resolveRepository(poolRepository)
poolRepository, err = resolveRepository(poolRepository, endpointName)
if err != nil {
return err
}
@ -113,7 +113,7 @@ Example:
listRepoPoolsReq.RepoID = poolRepository
response, err = apiCli.Repositories.ListRepoPools(listRepoPoolsReq, authToken)
} else if cmd.Flags().Changed("org") {
poolOrganization, err = resolveOrganization(poolOrganization)
poolOrganization, err = resolveOrganization(poolOrganization, endpointName)
if err != nil {
return err
}
@ -121,7 +121,7 @@ Example:
listOrgPoolsReq.OrgID = poolOrganization
response, err = apiCli.Organizations.ListOrgPools(listOrgPoolsReq, authToken)
} else if cmd.Flags().Changed("enterprise") {
poolEnterprise, err = resolveEnterprise(poolEnterprise)
poolEnterprise, err = resolveEnterprise(poolEnterprise, endpointName)
if err != nil {
return err
}
@ -262,7 +262,7 @@ var poolAddCmd = &cobra.Command{
var err error
var response poolPayloadGetter
if cmd.Flags().Changed("repo") {
poolRepository, err = resolveRepository(poolRepository)
poolRepository, err = resolveRepository(poolRepository, endpointName)
if err != nil {
return err
}
@ -271,7 +271,7 @@ var poolAddCmd = &cobra.Command{
newRepoPoolReq.Body = newPoolParams
response, err = apiCli.Repositories.CreateRepoPool(newRepoPoolReq, authToken)
} else if cmd.Flags().Changed("org") {
poolOrganization, err = resolveOrganization(poolOrganization)
poolOrganization, err = resolveOrganization(poolOrganization, endpointName)
if err != nil {
return err
}
@ -280,7 +280,7 @@ var poolAddCmd = &cobra.Command{
newOrgPoolReq.Body = newPoolParams
response, err = apiCli.Organizations.CreateOrgPool(newOrgPoolReq, authToken)
} else if cmd.Flags().Changed("enterprise") {
poolEnterprise, err = resolveEnterprise(poolEnterprise)
poolEnterprise, err = resolveEnterprise(poolEnterprise, endpointName)
if err != nil {
return err
}
@ -411,6 +411,8 @@ func init() {
poolListCmd.Flags().StringVarP(&poolEnterprise, "enterprise", "e", "", "List all pools within this enterprise.")
poolListCmd.Flags().BoolVarP(&poolAll, "all", "a", false, "List all pools, regardless of org or repo.")
poolListCmd.Flags().BoolVarP(&long, "long", "l", false, "Include additional info.")
poolListCmd.Flags().StringVar(&endpointName, "endpoint", "", "When using the name of an entity, the endpoint must be specified when multiple entities with the same name exist.")
poolListCmd.MarkFlagsMutuallyExclusive("repo", "org", "all", "enterprise")
poolUpdateCmd.Flags().StringVar(&poolImage, "image", "", "The provider-specific image name to use for runners in this pool.")
@ -444,6 +446,8 @@ func init() {
poolAddCmd.Flags().UintVar(&poolRunnerBootstrapTimeout, "runner-bootstrap-timeout", 20, "Duration in minutes after which a runner is considered failed if it does not join Github.")
poolAddCmd.Flags().UintVar(&poolMinIdleRunners, "min-idle-runners", 1, "Attempt to maintain a minimum of idle self-hosted runners of this type.")
poolAddCmd.Flags().BoolVar(&poolEnabled, "enabled", false, "Enable this pool.")
poolAddCmd.Flags().StringVar(&endpointName, "endpoint", "", "When using the name of an entity, the endpoint must be specified when multiple entities with the same name exist.")
poolAddCmd.MarkFlagRequired("provider-name") //nolint
poolAddCmd.MarkFlagRequired("image") //nolint
poolAddCmd.MarkFlagRequired("flavor") //nolint

21
cmd/garm-cli/cmd/repository.go
View file

@ -78,7 +78,7 @@ var repoWebhookInstallCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
repoID, err := resolveRepository(args[0])
repoID, err := resolveRepository(args[0], repoEndpoint)
if err != nil {
return err
}
@ -113,7 +113,7 @@ var repoHookInfoShowCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
repoID, err := resolveRepository(args[0])
repoID, err := resolveRepository(args[0], repoEndpoint)
if err != nil {
return err
}
@ -146,7 +146,7 @@ var repoWebhookUninstallCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
repoID, err := resolveRepository(args[0])
repoID, err := resolveRepository(args[0], repoEndpoint)
if err != nil {
return err
}
@ -259,7 +259,7 @@ var repoUpdateCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
repoID, err := resolveRepository(args[0])
repoID, err := resolveRepository(args[0], repoEndpoint)
if err != nil {
return err
}
@ -297,7 +297,7 @@ var repoShowCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
repoID, err := resolveRepository(args[0])
repoID, err := resolveRepository(args[0], repoEndpoint)
if err != nil {
return err
}
@ -330,7 +330,7 @@ var repoDeleteCmd = &cobra.Command{
return fmt.Errorf("too many arguments")
}
repoID, err := resolveRepository(args[0])
repoID, err := resolveRepository(args[0], repoEndpoint)
if err != nil {
return err
}
@ -367,12 +367,21 @@ func init() {
repoAddCmd.MarkFlagRequired("name") //nolint
repoDeleteCmd.Flags().BoolVar(&keepRepoWebhook, "keep-webhook", false, "Do not delete any existing webhook when removing the repo from GARM.")
repoDeleteCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "When using the name of the repo, the endpoint must be specified when multiple repositories with the same name exist.")
repoShowCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "When using the name of the repo, the endpoint must be specified when multiple repositories with the same name exist.")
repoUpdateCmd.Flags().StringVar(&repoWebhookSecret, "webhook-secret", "", "The webhook secret for this repository. If you update this secret, you will have to manually update the secret in GitHub as well.")
repoUpdateCmd.Flags().StringVar(&repoCreds, "credentials", "", "Credentials name. See credentials list.")
repoUpdateCmd.Flags().StringVar(&poolBalancerType, "pool-balancer-type", "", "The balancing strategy to use when creating runners in pools matching requested labels.")
repoUpdateCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "When using the name of the repo, the endpoint must be specified when multiple repositories with the same name exist.")
repoWebhookInstallCmd.Flags().BoolVar(&insecureRepoWebhook, "insecure", false, "Ignore self signed certificate errors.")
repoWebhookInstallCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "When using the name of the repo, the endpoint must be specified when multiple repositories with the same name exist.")
repoWebhookUninstallCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "When using the name of the repo, the endpoint must be specified when multiple repositories with the same name exist.")
repoHookInfoShowCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "When using the name of the repo, the endpoint must be specified when multiple repositories with the same name exist.")
repoWebhookCmd.AddCommand(
repoWebhookInstallCmd,

14
cmd/garm-cli/cmd/scalesets.go
View file

@ -105,7 +105,7 @@ Example:
switch len(args) {
case 0:
if cmd.Flags().Changed("repo") {
scalesetRepository, err = resolveRepository(scalesetRepository)
scalesetRepository, err = resolveRepository(scalesetRepository, endpointName)
if err != nil {
return err
}
@ -113,7 +113,7 @@ Example:
listRepoScaleSetsReq.RepoID = scalesetRepository
response, err = apiCli.Repositories.ListRepoScaleSets(listRepoScaleSetsReq, authToken)
} else if cmd.Flags().Changed("org") {
scalesetOrganization, err = resolveOrganization(scalesetOrganization)
scalesetOrganization, err = resolveOrganization(scalesetOrganization, endpointName)
if err != nil {
return err
}
@ -121,7 +121,7 @@ Example:
listOrgScaleSetsReq.OrgID = scalesetOrganization
response, err = apiCli.Organizations.ListOrgScaleSets(listOrgScaleSetsReq, authToken)
} else if cmd.Flags().Changed("enterprise") {
scalesetEnterprise, err = resolveEnterprise(scalesetEnterprise)
scalesetEnterprise, err = resolveEnterprise(scalesetEnterprise, endpointName)
if err != nil {
return err
}
@ -256,7 +256,7 @@ var scaleSetAddCmd = &cobra.Command{
var err error
var response scalesetPayloadGetter
if cmd.Flags().Changed("repo") {
scalesetRepository, err = resolveRepository(scalesetRepository)
scalesetRepository, err = resolveRepository(scalesetRepository, endpointName)
if err != nil {
return err
}
@ -265,7 +265,7 @@ var scaleSetAddCmd = &cobra.Command{
newRepoScaleSetReq.Body = newScaleSetParams
response, err = apiCli.Repositories.CreateRepoScaleSet(newRepoScaleSetReq, authToken)
} else if cmd.Flags().Changed("org") {
scalesetOrganization, err = resolveOrganization(scalesetOrganization)
scalesetOrganization, err = resolveOrganization(scalesetOrganization, endpointName)
if err != nil {
return err
}
@ -274,7 +274,7 @@ var scaleSetAddCmd = &cobra.Command{
newOrgScaleSetReq.Body = newScaleSetParams
response, err = apiCli.Organizations.CreateOrgScaleSet(newOrgScaleSetReq, authToken)
} else if cmd.Flags().Changed("enterprise") {
scalesetEnterprise, err = resolveEnterprise(scalesetEnterprise)
scalesetEnterprise, err = resolveEnterprise(scalesetEnterprise, endpointName)
if err != nil {
return err
}
@ -402,6 +402,7 @@ func init() {
scalesetListCmd.Flags().StringVarP(&scalesetEnterprise, "enterprise", "e", "", "List all scale sets within this enterprise.")
scalesetListCmd.Flags().BoolVarP(&scalesetAll, "all", "a", false, "List all scale sets, regardless of org or repo.")
scalesetListCmd.MarkFlagsMutuallyExclusive("repo", "org", "all", "enterprise")
scalesetListCmd.Flags().StringVar(&endpointName, "endpoint", "", "When using the name of an entity, the endpoint must be specified when multiple entities with the same name exist.")
scaleSetUpdateCmd.Flags().StringVar(&scalesetImage, "image", "", "The provider-specific image name to use for runners in this scale set.")
scaleSetUpdateCmd.Flags().StringVar(&scalesetFlavor, "flavor", "", "The flavor to use for the runners in this scale set.")
@ -432,6 +433,7 @@ func init() {
scaleSetAddCmd.Flags().UintVar(&scalesetRunnerBootstrapTimeout, "runner-bootstrap-timeout", 20, "Duration in minutes after which a runner is considered failed if it does not join Github.")
scaleSetAddCmd.Flags().UintVar(&scalesetMinIdleRunners, "min-idle-runners", 1, "Attempt to maintain a minimum of idle self-hosted runners of this type.")
scaleSetAddCmd.Flags().BoolVar(&scalesetEnabled, "enabled", false, "Enable this scale set.")
scaleSetAddCmd.Flags().StringVar(&endpointName, "endpoint", "", "When using the name of an entity, the endpoint must be specified when multiple entities with the same name exist.")
scaleSetAddCmd.MarkFlagRequired("provider-name") //nolint
scaleSetAddCmd.MarkFlagRequired("name") //nolint
scaleSetAddCmd.MarkFlagRequired("image") //nolint

22
cmd/garm-cli/cmd/util.go
View file

@ -11,7 +11,7 @@ import (
apiClientRepos "github.com/cloudbase/garm/client/repositories"
)
func resolveRepository(nameOrID string) (string, error) {
func resolveRepository(nameOrID, endpoint string) (string, error) {
if nameOrID == "" {
return "", fmt.Errorf("missing repository name or ID")
}
@ -30,6 +30,9 @@ func resolveRepository(nameOrID string) (string, error) {
listReposReq := apiClientRepos.NewListReposParams()
listReposReq.Owner = &parts[0]
listReposReq.Name = &parts[1]
if endpoint != "" {
listReposReq.Endpoint = &endpoint
}
response, err := apiCli.Repositories.ListRepos(listReposReq, authToken)
if err != nil {
return "", err
@ -39,12 +42,12 @@ func resolveRepository(nameOrID string) (string, error) {
}
if len(response.Payload) > 1 {
return "", fmt.Errorf("multiple repositories with the name %s exist, please use the repository ID", nameOrID)
return "", fmt.Errorf("multiple repositories with the name %s exist, please use the repository ID or specify the --endpoint parameter", nameOrID)
}
return response.Payload[0].ID, nil
}
func resolveOrganization(nameOrID string) (string, error) {
func resolveOrganization(nameOrID, endpoint string) (string, error) {
if nameOrID == "" {
return "", fmt.Errorf("missing organization name or ID")
}
@ -55,6 +58,9 @@ func resolveOrganization(nameOrID string) (string, error) {
listOrgsReq := apiClientOrgs.NewListOrgsParams()
listOrgsReq.Name = &nameOrID
if endpoint != "" {
listOrgsReq.Endpoint = &endpoint
}
response, err := apiCli.Organizations.ListOrgs(listOrgsReq, authToken)
if err != nil {
return "", err
@ -65,13 +71,13 @@ func resolveOrganization(nameOrID string) (string, error) {
}
if len(response.Payload) > 1 {
return "", fmt.Errorf("multiple organizations with the name %s exist, please use the organization ID", nameOrID)
return "", fmt.Errorf("multiple organizations with the name %s exist, please use the organization ID or specify the --endpoint parameter", nameOrID)
}
return response.Payload[0].ID, nil
}
func resolveEnterprise(nameOrID string) (string, error) {
func resolveEnterprise(nameOrID, endpoint string) (string, error) {
if nameOrID == "" {
return "", fmt.Errorf("missing enterprise name or ID")
}
@ -82,7 +88,9 @@ func resolveEnterprise(nameOrID string) (string, error) {
listEnterprisesReq := apiClientEnterprises.NewListEnterprisesParams()
listEnterprisesReq.Name = &enterpriseName
listEnterprisesReq.Endpoint = &enterpriseEndpoint
if endpoint != "" {
listEnterprisesReq.Endpoint = &endpoint
}
response, err := apiCli.Enterprises.ListEnterprises(listEnterprisesReq, authToken)
if err != nil {
return "", err
@ -93,7 +101,7 @@ func resolveEnterprise(nameOrID string) (string, error) {
}
if len(response.Payload) > 1 {
return "", fmt.Errorf("multiple enterprises with the name %s exist, please use the enterprise ID", nameOrID)
return "", fmt.Errorf("multiple enterprises with the name %s exist, please use the enterprise ID or specify the --endpoint parameter", nameOrID)
}
return response.Payload[0].ID, nil