package
0.0.0-20230928123041-2caf503550cc
Repository: https://github.com/giantswarm/gsctl.git
Documentation: pkg.go.dev

# Functions

HandleCommonErrors is a common function to handle certain errors happening in more than one command.
IsAccessForbiddenError asserts AccessForbiddenError.
IsAPIError asserts APIError.
IsBadRequestError asserts BadRequestError.
IsCannotScaleBelowMinimumWorkersError asserts CannotScaleBelowMinimumWorkersError.
IsCannotScaleCluster asserts CannotScaleClusterError.
IsClusterDoesNotSupportNodePools asserts ClusterDoesNotSupportNodePoolsError.
IsClusterNameOrIDMissingError asserts ClusterNameOrIDMissingError.
IsClusterNotFoundError asserts ClusterNotFoundError.
IsClusterOwnerMissingError asserts ClusterOwnerMissingError.
IsCommandAbortedError asserts CommandAbortedError.
IsConflictingFlagsError asserts ConflictingFlagsError.
IsConflictingWorkerFlagsUsed asserts ConflictingWorkerFlagsUsedError.
IsCouldNotCreateClientError asserts CouldNotCreateClientError.
IsCouldNotCreateClusterError asserts CouldNotCreateClusterError.
IsCouldNotCreateJSONRequestBodyError asserts CouldNotCreateJSONRequestBodyError.
IsCouldNotDeleteClusterError asserts CouldNotDeleteClusterError.
IsCouldNotDeleteEndpointError asserts CouldNotDeleteEndpointError.
IsCouldNotScaleClusterError asserts CouldNotScaleClusterError.
IsCouldNotUpgradeClusterError asserts CouldNotUpgradeClusterError.
IsCouldNotWriteFileError asserts CouldNotWriteFileError.
IsCredentialNotFoundError asserts CredentialNotFoundError.
IsCredentialsAlreadySetError asserts CredentialsAlreadySetError.
IsDesiredEqualsCurrentStateError asserts DesiredEqualsCurrentStateError.
IsDurationExceededError asserts DurationExceededError.
IsEmptyPasswordError asserts EmptyPasswordError.
IsEndpointMissingError asserts EndpointMissingError.
IsEndpointNotFoundError asserts EndpointNotFoundError.
IsIncompatibleSettings asserts IncompatibleSettingsError.
IsInternalServerError asserts InternalServerError.
IsInvalidCNPrefixError asserts InvalidCNPrefixError.
IsInvalidCredentialsError asserts InvalidCredentialsError.
IsInvalidDurationError asserts InvalidDurationError.
IsInvalidNodePoolIDArgument asserts InvalidNodePoolIDArgumentError.
IsInvalidReleaseError asserts InvalidReleaseError.
IsKubectlMissingError asserts KubectlMissingError.
IsNodePoolIDMalformedError asserts IsNodePoolIDMalformedError.
IsNodePoolIDMissingError asserts NodePoolIDMissingError.
IsNodePoolNotFound asserts NodePoolNotFoundError.
IsNoEmailArgumentGivenError asserts NoEmailArgumentGivenError.
IsNoOpError asserts NoOpError.
IsNoResponseError asserts NoResponseError.
IsNotAuthorizedError asserts NotAuthorizedError.
IsNotEnoughWorkerNodesError asserts NotEnoughWorkerNodesError.
IsNotLoggedInError asserts NotLoggedInError.
IsNoUpgradeAvailableError asserts NoUpgradeAvailableError.
IsOrganizationNotFoundError asserts OrganizationNotFoundError.
IsOrganizationNotSpecifiedError asserts OrganizationNotSpecifiedError.
IsOutputFormatInvalid asserts OutputFormatInvalidError.
IsPasswordArgumentNotApplicableError asserts PasswordArgumentNotApplicableError.
IsProviderNotSupportedError asserts ProviderNotSupportedError.
IsReleaseNotFoundError asserts ReleaseNotFoundError.
IsReleaseVersionMissingError asserts ReleaseVersionMissingError.
IsRequiredFlagMissingError asserts RequiredFlagMissingError.
IsSSOError asserts SSOError.
IsTokenArgumentNotApplicableError asserts TokenArgumentNotApplicableError.
IsUnknownError asserts UnknownError.
IsUnspecifiedAPIError asserts UnspecifiedAPIError.
IsUpdateCheckFailed asserts UpdateCheckFailed.
IsUserAccountInactiveError asserts UserAccountInactiveError.
IsWorkersMinMaxInvalid asserts WorkersMinMaxInvalidError.
IsYAMLFileNotReadable asserts YAMLFileNotReadableError.
IsYAMLNotParseable asserts YAMLNotParseableError.

# Variables

AccessForbiddenError means the client has been denied access to the API endpoint with a HTTP 403 error.
APIError is happening when an error occurs in the API.
BadRequestError should be used when the server returns status 400 on cluster creation.
CannotScaleBelowMinimumWorkersError means the user tries to scale to less nodes than allowed.
CannotScaleClusterError means the user tries to scale a cluster that does not support scaling, e.
ClusterDoesNotSupportNodePoolsError is raised when the user tries to do something with node pools on a cluster that does not support node pools.
ClusterNameOrIDMissingError means a required cluster ID has not been given as input.
ClusterNotFoundError means that a given cluster does not exist.
ClusterOwnerMissingError means that the user has not specified an owner organization for a new cluster.
CommandAbortedError means that the user has aborted a command or input.
ConflictingFlagsError means that the user combined command line options that are incompatible.
ConflictingWorkerFlagsUsedError is raised when the deprecated --num-workers flag is used together with the new node count flags --workers-min and --workers-max.
CouldNotCreateClientError means that a client could not be created.
CouldNotCreateClusterError should be used if the API call to create a cluster has been responded with status >= 400 and none of the other more specific errors apply.
CouldNotCreateJSONRequestBodyError occurs when we could not create a JSON request body based on the input we have, so something in out input attributes is wrong.
CouldNotDeleteClusterError should be used if the API call to delete a cluster has been responded with status >= 400.
CouldNotDeleteEndpointError should be used when the "API endpoint" could not be deleted.
CouldNotScaleClusterError should be used if the API call to scale a cluster has been responded with status >= 400.
CouldNotUpgradeClusterError is thrown when a cluster upgrade failed.
CouldNotWriteFileError is used when an attempt to write some file fails.
CredentialNotFoundError means that the specified credential could not be found.
CredentialsAlreadySetError means the user tried setting credential to an org that has credentials already.
DesiredEqualsCurrentStateError means that the user described a desired state which is equal to the current state.
DurationExceededError is thrown when a duration value is larger than can be represented internally.
EmptyPasswordError means the password supplied by the user was empty.
EndpointMissingError means the user has not given an endpoint where expected.
EndpointNotFoundError should be used when the user tries to delete an "API endpoint" that does not exist.
IncompatibleSettingsError means user has mixed incompatible settings related to different providers.
InternalServerError should only be used in case of server communication being responded to with a response status >= 500.
InvalidCNPrefixError means the user has used bad characters in the CN prefix argument.
InvalidCredentialsError means the user's credentials could not be verified by the API.
InvalidDurationError means that a user-provided duration string could not be parsed.
InvalidNodePoolIDArgumentError should be raised when the user gives a "clusterID/nodepoolID" argument that is syntactically incorrect.
InvalidReleaseError means that the customer entered an invalid release.
KubectlMissingError means that the 'kubectl' executable is not available.
NodePoolIDMalformedError means a cluster/nodepool ID tuple has been formatted the wrong way.
NodePoolIDMissingError means a required node pool ID has not been given as input.
NodePoolNotFoundError means that a node pool the user wants to interact with does not exist.
NoEmailArgumentGivenError means the email argument was required but not given/empty.
NoOpError is raised when the user calls a command without any meaningful parameters, resulting in no change/nothing done.
NoResponseError means the server side has not returned a response.
NotAuthorizedError means that an API action could not be performed due to an authorization problem (usually a HTTP 401 error).
NotEnoughWorkerNodesError means that the user has specified a too low number of worker nodes for a cluster.
NotLoggedInError means that the user is currently not authenticated.
NotPercentage should be used when the user tries to set a percentage value outside 0-100.
NoUpgradeAvailableError means that the user wanted to start an upgrade, but there is no newer version available for the given cluster.
OrganizationNotFoundError means that the specified organization could not be found.
OrganizationNotSpecifiedError means that the user has not specified an organization to work with.
OutputFormatInvalidError is raised when the user specifies an unsupported output format.
PasswordArgumentNotApplicableError means the user used --password argument but it wasn't permitted for that command.
ProviderNotSupportedError means that the intended action is not possible with the installation's provider.
ReleaseNotFoundError means that a given release does not exist.
ReleaseVersionMissingError means the required release version argument is missing.
RequiredFlagMissingError means that a required flag has not been set by the user.
SSOError means something went wrong during the SSO process.
TokenArgumentNotApplicableError means the user used --auth-token argument but it wasn't permitted for that command.
UnknownError should be thrown if we have no idea what went wrong.
UnspecifiedAPIError means an API error has occurred which we can't or don't need to categorize any further.
UpdateCheckFailed means that checking for a newer gsctl version failed.
UserAccountInactiveError means that the user account is marked as inative by the API.
WorkersMinMaxInvalidError is raised when the value of the node count flag --workers-min is higher than the value of the node count flag --workers-max.
YAMLFileNotReadableError means a YAML file was not readable.
YAMLNotParseableError means a YAML file was not readable.