Skip to main content
Version: Next

@backstage/plugin-kubernetes-backend

Home > @backstage/plugin-kubernetes-backend

A Backstage backend plugin that integrates towards Kubernetes

Classes

Class

Description

AksStrategy

AnonymousStrategy

AwsIamStrategy

AzureIdentityStrategy

DispatchStrategy

used to direct a KubernetesAuthProvider to its corresponding AuthenticationStrategy

GoogleServiceAccountStrategy

GoogleServiceAccountStrategy provides authentication using Google Service Account credentials.

Credentials can be provided via configuration:

kubernetes:
googleServiceAccountCredentials: |
{
"type": "service_account",
"project_id": "your-project-id",
"private_key_id": "key-id",
"private_key": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n",
"client_email": "your-service-account@your-project.iam.gserviceaccount.com",
"client_id": "client-id",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/..."
}

If no credentials are provided in config, falls back to GOOGLE_APPLICATION_CREDENTIALS or ADC.

GoogleStrategy

KubernetesProxy

A proxy that routes requests to the Kubernetes API.

OidcStrategy

ServiceAccountStrategy

Interfaces

Interface

Description

KubernetesObjectsProviderOptions

Variables

Variable

Description

DEFAULT_OBJECTS

HEADER_KUBERNETES_AUTH

The header that is used to specify the Authentication Authorities token. e.x if using the google auth provider as your authentication authority then this field would be the google provided bearer token.

HEADER_KUBERNETES_CLUSTER

The header that is used to specify the cluster name.

kubernetesPlugin

This is the backend plugin that provides the Kubernetes integration.

Type Aliases

Type Alias

Description

DispatchStrategyOptions

KubernetesProxyCreateRequestHandlerOptions

The options object expected to be passed as a parameter to KubernetesProxy.createRequestHandler().

KubernetesProxyOptions

Options accepted as a parameter by the KubernetesProxy

ObjectsByEntityRequest

ServiceLocatorMethod

SigningCreds