1Password Connect Kubernetes Operator

The 1Password Connect Kubernetes Operator provides the ability to integrate Kubernetes with 1Password. This Operator manages OnePasswordItem Custom Resource Definitions (CRDs) that define the location of an Item stored in 1Password. The OnePasswordItem CRD, when created, will be used to compose a Kubernetes Secret containing the contents of the specified item.

The 1Password Connect Kubernetes Operator also allows for Kubernetes Secrets to be composed from a 1Password Item through annotation of an Item Path on a deployment.

The 1Password Connect Kubernetes Operator will continually check for updates from 1Password for any Kubernetes Secret that it has generated. If a Kubernetes Secret is updated, any Deployment using that secret will be automatically restarted.

Setup

Prerequisites:

Kubernetes Operator Deployment

Create Kubernetes Secret for OP_CONNECT_TOKEN

# where <OP_CONNECT_TOKEN> is the 1Password Connect API token
$ kubectl create secret generic onepassword-token --from-literal=token=<OP_CONNECT_TOKEN>

Set Permissions For Operator

We must create a service account, role, and role binding and Kubernetes. Examples can be found in the /deploy folder.

$ kubectl apply -f deploy/permissions.yaml

Create Custom One Password Secret Resource

$ kubectl apply -f deploy/crds/onepassword.com_onepassworditems_crd.yaml

Deploying the Operator

An example Deployment yaml can be found at /deploy/operator.yaml.

containers:
    - name: onepassword-operator
      image: 1password/onepassword-operator

and update the image pull policy to Always

imagePullPolicy: Always

To further configure the 1Password Kubernetes Operator the Following Environment variables can be set in the deployment yaml:

WATCH_NAMESPACE: comma separated list of what Namespaces to watch for changes.
OP_CONNECT_HOST (required): Specifies the host name within Kubernetes in which to access the 1Password Connect.
POLLING_INTERVAL (default: 600): The number of seconds ****the 1Password Kubernetes Operator will wait before checking for updates from 1Password Connect.

Apply the deployment file:

kubectl apply -f deploy/operator.yaml

Usage

To create a Kubernetes Secret from a 1Password item, create a yaml file with the following

apiVersion: onepassword.com/v1
kind: OnePasswordItem # {insert_new_name}
metadata:
  name: {item_name} #this name will also be used for naming the generated kubernetes secret
spec:
  item-path: "vaults/{vaultId}/items/{itemId}" 
# where vaultId is the id of the vault in which to find the item
# where itemId is the id of the item that you want to store as a Kubernetes Secret

Deploy the OnePasswordItem to Kubernetes:

$ kubectl apply -f {your_item}.yaml

To test that the Kubernetes Secret check that the following command returns a secret:

$ kubectl get secret {secret_name}

Note: Deleting the OnePasswordItem that you've created will automatically delete the created Kubernetes Secret.

To create a single Kubernetes Secret for a deployment, add the following annotations to the deployment metadata:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: deployment-example
  annotations:
    onepasswordoperator/item-path: "vaults/{vaultId}/items/{itemId}"
    onepasswordoperator/item-name: "{secret_name}"

Applying this yaml file will create a Kubernetes Secret with the name {secret_name} and contents from the location specified at the specified Item Path.

Note: Deleting the Deployment that you've created will automatically delete the created Kubernetes Secret only if the deployment is still annotated with onepasswordoperator./item-path and onepasswordoperator/item-name and no other deployment is using the secret.

If a 1Password Item that is linked to a Kubernetes Secret is updated within the POLLING_INTERVAL the associated Kubernetes Secret will be updated. Furthermore, any deployments using that secret will be given a rolling restart.

Development

Running Tests

$ go test -v ./... -cover

Security

1Password requests you practice responsible disclosure if you discover a vulnerability.

Please file requests via BugCrowd.

For information about security practices, please visit our Security homepage.

4.8 KiB Raw Blame History