Armada Exceptions

API Exceptions

exception armada.exceptions.api_exceptions.ApiException(message=None, **kwargs)[source]

Bases: ArmadaBaseException

Base class for API exceptions and error handling.

Troubleshoot: Coming Soon

message = 'An unknown API error occurred.'

exception armada.exceptions.api_exceptions.ClientError(message=None, **kwargs)[source]

Bases: ApiException

Exception that occurs when the server returns a 500 Internal Server error.

Troubleshoot: Coming Soon

message = 'There was an error listing the Helm chart releases.'

exception armada.exceptions.api_exceptions.ClientForbiddenError(message=None, **kwargs)[source]

Bases: ApiException

Exception that occurs when the server returns a 403 Forbidden error.

Troubleshoot: Coming Soon

message = 'There was an error listing the Helm chart releases.'

exception armada.exceptions.api_exceptions.ClientUnauthorizedError(message=None, **kwargs)[source]

Bases: ApiException

Exception that occurs when the server returns a 401 Unauthorized error.

Troubleshoot: Coming Soon

message = 'There was an error listing the Helm chart releases.'

Armada Exceptions

exception armada.exceptions.armada_exceptions.ArmadaTimeoutException(reason)[source]

Bases: ArmadaException

Exception that occurs when Armada times out while processing.

exception armada.exceptions.armada_exceptions.ProtectedReleaseException(release_id, status)[source]

Bases: ArmadaException

Exception that occurs when Armada encounters a release with status other than DEPLOYED that is designated protected in the Chart and continue_processing is False.

exception armada.exceptions.armada_exceptions.InvalidValuesYamlException(chart_description)[source]

Bases: ArmadaException

Exception that occurs when Armada encounters invalid values.yaml content in a helm chart.

exception armada.exceptions.armada_exceptions.InvalidOverrideValuesYamlException(chart_description)[source]

Bases: ArmadaException

Exception that occurs when Armada encounters invalid override yaml in helm chart.

exception armada.exceptions.armada_exceptions.ChartDeployException(chart_names)[source]

Bases: ArmadaException

Exception that occurs while deploying charts.

exception armada.exceptions.armada_exceptions.WaitException(message)[source]

Bases: ArmadaException

Exception that occurs while waiting for resources to become ready.

exception armada.exceptions.armada_exceptions.DeploymentLikelyPendingException(release_id, status, last_deployment_age, timeout)[source]

Bases: ArmadaException

Exception that occurs when it is detected that an existing release operation (e.g. install, update, delete) is likely still pending.

exception armada.exceptions.armada_exceptions.PreUpdateJobDeleteException(name, namespace)[source]

Bases: ArmadaException

Exception that occurs when a job deletion.

Troubleshoot: Coming Soon

Base Exceptions

exception armada.exceptions.base_exception.ActionForbidden(title=None, description=None, error_list=None, info_list=None, status=None, retry=False)[source]

Bases: ArmadaAPIException

Exception thrown when an action is forbidden.

Troubleshoot: Coming Soon

code: An internal application code that a user can reference when requesting support for the error.

description: Description of the error to send to the client.

headers: Extra headers to add to the response.

link: An href that the client can provide to the user for getting help.

message = 'Insufficient privilege to perform action.'

status

HTTP status code or line (e.g., '200 OK').

This may be set to a member of http.HTTPStatus, an HTTP status line string or byte string (e.g., '200 OK'), or an int.

title

Error title to send to the client.

Derived from the status if not provided.

Chartbuilder Exceptions

exception armada.exceptions.chartbuilder_exceptions.HelmChartBuildException(chart_name, details)[source]

Bases: ChartBuilderException

Exception that occurs when Helm Chart fails to build.

Kubernetes Exceptions

exception armada.exceptions.k8s_exceptions.KubernetesErrorEventException(message=None, **kwargs)[source]

Bases: KubernetesException

Exception for getting an error from the Kubernetes API

message = 'An error event was returned from the streaming API.'

exception armada.exceptions.k8s_exceptions.KubernetesUnknownStreamingEventTypeException(message=None, **kwargs)[source]

Bases: KubernetesException

Exception for getting an unknown event type from the Kubernetes API

message = 'An unknown event type was returned from the streaming API.'

exception armada.exceptions.k8s_exceptions.KubernetesWatchTimeoutException(message=None, **kwargs)[source]

Bases: KubernetesException

Exception for timing out during a watch on a Kubernetes object

message = 'Kubernetes Watch has timed out.'

Manifest Exceptions

exception armada.exceptions.manifest_exceptions.ManifestException(message=None, **kwargs)[source]

Bases: ArmadaBaseException

An exception occurred while attempting to build an Armada manifest. The exception will return with details as to why.

Troubleshoot: Coming Soon

message = 'An error occurred while generating the manifest: %(details)s.'

Override Exceptions

exception armada.exceptions.override_exceptions.InvalidOverrideFileException(filename)[source]

Bases: OverrideException

Exception that occurs when an invalid override file is provided.

Troubleshoot: Coming Soon

exception armada.exceptions.override_exceptions.InvalidOverrideValueException(override_command)[source]

Bases: OverrideException

Exception that occurs when an invalid value is used with the set flag.

Troubleshoot: Coming Soon

exception armada.exceptions.override_exceptions.UnknownDocumentOverrideException(doc_type, doc_name)[source]

Bases: OverrideException

Exception that occurs when an invalid value is used with the set flag.

Troubleshoot: Coming Soon

Source Exceptions

exception armada.exceptions.source_exceptions.ChartSourceException(chart_name, source_type)[source]

Bases: SourceException

Exception for unknown chart source type.

Troubleshoot: Coming Soon

exception armada.exceptions.source_exceptions.GitException(location)[source]

Bases: SourceException

Exception when an error occurs cloning a Git repository.

Troubleshoot: Coming Soon

exception armada.exceptions.source_exceptions.InvalidPathException(path)[source]

Bases: SourceException

Exception that occurs when a nonexistant path is accessed.

Troubleshoot: Coming Soon

exception armada.exceptions.source_exceptions.TarballDownloadException(tarball_url)[source]

Bases: SourceException

Exception that occurs when the tarball cannot be downloaded from the provided URL.

Troubleshoot: Coming Soon

exception armada.exceptions.source_exceptions.TarballExtractException(tarball_dir)[source]

Bases: SourceException

Exception that occurs when extracting the tarball fails.

Troubleshoot: Coming Soon

Lint (Validate) Exceptions

exception armada.exceptions.validate_exceptions.InvalidManifestException(message=None, **kwargs)[source]

Bases: ValidateException

Exception for invalid manifests.

Troubleshoot: Coming Soon

message = 'Armada manifest(s) failed validation. Details: %(error_messages)s.'

exception armada.exceptions.validate_exceptions.InvalidChartDefinitionException(message=None, **kwargs)[source]

Bases: ValidateException

Exception when invalid chart definition is encountered.

message = 'Invalid chart definition. Chart definition must be array.'

exception armada.exceptions.validate_exceptions.InvalidReleaseException(message=None, **kwargs)[source]

Bases: ValidateException

Exception that occurs when a release is invalid.

message = 'Release needs to be a string.'

exception armada.exceptions.validate_exceptions.InvalidArmadaObjectException(message=None, **kwargs)[source]

Bases: ValidateException

Exception that occurs when an Armada object is not declared.

Troubleshoot: Coming Soon

message = 'An Armada object failed internal validation. Details: %(details)s.'