Package types (0.2.0)

API documentation for telcoautomation_v1alpha1.types package.

Classes

ApplyDeploymentRequest

Request object for ApplyDeployment. The resources in given deployment gets applied to Orchestration Cluster. A new revision is created when a deployment is applied.

ApplyHydratedDeploymentRequest

Request for applying a hydrated deployment.

A Blueprint contains a collection of kubernetes resources in the form of YAML files. The file contents of a blueprint are collectively known as package. A blueprint can be a) imported from TNA's public catalog b) modified as per a user's need c) proposed and approved. On approval, a revision of blueprint is created which can be used to create a deployment on Orchestration or Workload Cluster.

BlueprintView

BlueprintView defines the type of view of the blueprint.

Values: BLUEPRINT_VIEW_UNSPECIFIED (0): Unspecified enum value. BLUEPRINT_VIEW_BASIC (1): View which only contains metadata. BLUEPRINT_VIEW_FULL (2): View which contains metadata and files it encapsulates.

ComputeDeploymentStatusRequest

Request object for ComputeDeploymentStatus.

ComputeDeploymentStatusResponse

Response object for ComputeDeploymentStatus.

CreateBlueprintRequest

Request object for CreateBlueprint.

CreateDeploymentRequest

Request object for CreateDeployment.

CreateEdgeSlmRequest

Message for creating a EdgeSlm.

CreateOrchestrationClusterRequest

Message for creating a OrchestrationCluster.

DeleteBlueprintRequest

Request object for DeleteBlueprint.

DeleteEdgeSlmRequest

Message for deleting a EdgeSlm.

DeleteOrchestrationClusterRequest

Message for deleting a OrchestrationCluster.

Deployment

Deployment contains a collection of YAML files (This collection is also known as package) that can to applied on an orchestration cluster (GKE cluster with TNA addons) or a workload cluster.

DeploymentLevel

DeploymentLevel of a blueprint signifies where the blueprint will be applied.

Values: DEPLOYMENT_LEVEL_UNSPECIFIED (0): Default unspecified deployment level. HYDRATION (1): Blueprints at HYDRATION level cannot be used to create a Deployment (A user cannot manually initate deployment of these blueprints on orchestration or workload cluster). These blueprints stay in a user's private catalog and are configured and deployed by TNA automation. SINGLE_DEPLOYMENT (2): Blueprints at SINGLE_DEPLOYMENT level can be a) Modified in private catalog. b) Used to create a deployment on orchestration cluster by the user, once approved. MULTI_DEPLOYMENT (3): Blueprints at MULTI_DEPLOYMENT level can be a) Modified in private catalog. b) Used to create a deployment on orchestration cluster which will create further hydrated deployments. WORKLOAD_CLUSTER_DEPLOYMENT (4): Blueprints at WORKLOAD_CLUSTER_DEPLOYMENT level can be a) Modified in private catalog. b) Used to create a deployment on workload cluster by the user, once approved.

DeploymentView

DeploymentView defines the type of view of the deployment.

Values: DEPLOYMENT_VIEW_UNSPECIFIED (0): Unspecified enum value. DEPLOYMENT_VIEW_BASIC (1): View which only contains metadata. DEPLOYMENT_VIEW_FULL (2): View which contains metadata and files it encapsulates.

DiscardBlueprintChangesRequest

Request object for DiscardBlueprintChanges.

DiscardBlueprintChangesResponse

Response object for DiscardBlueprintChanges.

DiscardDeploymentChangesRequest

Request object for DiscardDeploymentChanges.

DiscardDeploymentChangesResponse

Response object for DiscardDeploymentChanges.

EdgeSlm

EdgeSlm represents an SLM instance which manages the lifecycle of edge components installed on Workload clusters managed by an Orchestration Cluster.

File

File represents a yaml file present in a blueprint's package.

FullManagementConfig

Configuration of the full (Autopilot) cluster management

GetBlueprintRequest

Request object for GetBlueprint.

GetDeploymentRequest

Request object for GetDeployment.

GetEdgeSlmRequest

Message for getting a EdgeSlm.

GetHydratedDeploymentRequest

Request object for GetHydratedDeployment.

GetOrchestrationClusterRequest

Message for getting a OrchestrationCluster.

GetPublicBlueprintRequest

Request object for GetPublicBlueprint.

HydratedDeployment

A collection of kubernetes yaml files which are deployed on a Workload Cluster. Hydrated Deployments are created by TNA intent based automation.

HydrationStatus

Hydration status.

ListBlueprintRevisionsRequest

Request object for ListBlueprintRevisions.

ListBlueprintRevisionsResponse

Response object for ListBlueprintRevisions.

ListBlueprintsRequest

Request object for ListBlueprints.

ListBlueprintsResponse

Response object for ListBlueprints.

ListDeploymentRevisionsRequest

Request for listing all revisions of a deployment.

ListDeploymentRevisionsResponse

List of deployment revisions for a given deployment.

ListDeploymentsRequest

Request object for ListDeployments.

ListDeploymentsResponse

Response object for ListDeployments.

ListEdgeSlmsRequest

Message for requesting list of EdgeSlms

ListEdgeSlmsResponse

Message for response to listing EdgeSlms.

ListHydratedDeploymentsRequest

Request object for ListHydratedDeployments.

ListHydratedDeploymentsResponse

Response object for ListHydratedDeployments.

ListOrchestrationClustersRequest

Message for requesting list of OrchestrationClusters.

ListOrchestrationClustersResponse

Message for response to listing OrchestrationClusters.

ListPublicBlueprintsRequest

Request object for ListPublicBlueprints.

ListPublicBlueprintsResponse

Response object for ListPublicBlueprints.

ManagementConfig

Configuration of the cluster management

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MasterAuthorizedNetworksConfig

Configuration of the Master Authorized Network that support multiple CIDRs

NFDeploySiteStatus

Per-Site Status.

NFDeployStatus

Deployment status of NFDeploy.

OperationMetadata

Represents the metadata of the long-running operation.

OrchestrationCluster

Orchestration cluster represents a GKE cluster with config controller and TNA specific components installed on it.

ProposeBlueprintRequest

Request object for ProposeBlueprint.

PublicBlueprint

A Blueprint contains a collection of kubernetes resources in the form of YAML files. The file contents of a blueprint are collectively known as package. Public blueprint is a TNA provided blueprint that in present in TNA's public catalog. A user can copy the public blueprint to their private catalog for further modifications.

RejectBlueprintRequest

Request object for RejectBlueprint.

RemoveDeploymentRequest

Request object for RemoveDeployment.

ResourceStatus

Status of a deployment resource.

ResourceType

Represent type of CR.

Values: RESOURCE_TYPE_UNSPECIFIED (0): Unspecified resource type. NF_DEPLOY_RESOURCE (1): User specified NF Deploy CR. DEPLOYMENT_RESOURCE (2): CRs that are part of a blueprint.

RollbackDeploymentRequest

Request object for RollbackDeployment.

SearchBlueprintRevisionsRequest

Request object for SearchBlueprintRevisions.

SearchBlueprintRevisionsResponse

Response object for SearchBlueprintRevisions.

SearchDeploymentRevisionsRequest

Request object for SearchDeploymentRevisions.

SearchDeploymentRevisionsResponse

Response object for SearchDeploymentRevisions.

SiteVersion

SiteVersion Hydration is targeting.

StandardManagementConfig

Configuration of the standard (GKE) cluster management.

Status

Status of an entity (resource, deployment).

Values: STATUS_UNSPECIFIED (0): Unknown state. STATUS_IN_PROGRESS (1): Under progress. STATUS_ACTIVE (2): Running and ready to serve traffic. STATUS_FAILED (3): Failed or stalled. STATUS_DELETING (4): Delete in progress. STATUS_DELETED (5): Deleted deployment. STATUS_PEERING (10): NFDeploy specific status. Peering in progress. STATUS_NOT_APPLICABLE (11): K8s objects such as NetworkAttachmentDefinition don't have a defined status.