Aembit Client ID

The Aembit Client ID method serves as a fallback for Client Workload identification when other suitable methods are unavailable. This method entails generating a unique ID by the Aembit Cloud, which is then provisioned to the Client Workload.

The Aembit Client ID isn’t the Client Workload’s resource ID

Every Client Workload also has its own resource ID, which Aembit assigns automatically and exposes as externalId in the API. That resource ID isn’t the Aembit Client ID, and no flag, variable, or annotation accepts it.

Whenever you provision this identifier—through the --client-workload-id flag, the CLIENT_WORKLOAD_ID environment variable, or the aembit.io/client-id annotation—use the value Aembit generates in the following step. Both values use the same UUID format, so confirm you copied the generated one.

For a side-by-side comparison of all three identifiers, see the Aembit identifier reference.

Applicable deployment type

This method is suitable for Aembit Edge-based deployments.

Configuration

Aembit Cloud

1. Create a new Client Workload.
2. Choose “Aembit Client ID” for client identification.
3. Complete the remaining fields.
4. Copy the newly generated ID that Aembit displays for the Aembit Client ID identifier.
5. Save the Client Workload.

Client Workload

Virtual machine deployment

During Agent Proxy installation, specify the CLIENT_WORKLOAD_ID environment variable.

CLIENT_WORKLOAD_ID=<ClientWorkloadID> AEMBIT_TENANT_ID=<TenantID> AEMBIT_AGENT_CONTROLLER_ID=<AgentControllerId> ./install

Kubernetes

Add the aembit.io/agent-inject annotation to your Client Workload.

See the following example:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: example-app
spec:
  replicas: 1
  selector:
    matchLabels:
      app: example-app
  template:
    metadata:
      labels:
        app: example-app
      annotations:
        aembit.io/agent-inject: "enabled"
        aembit.io/client-id: "7e75e718-7634-480b-9f7b-a07bb5a4f11d"