1Password SCIM bridge Helm chart

This is the offical Helm chart for deploying the 1Password SCIM bridge.

The chart exists to facilitate our one-click deployment options for the Google Cloud Marketplace and DigitalOcean Marketplace applications. With this in mind the chart is tailored to our specific use case and will likely not meet the requirements of every configuration option or deployment scenario. For more general purpose deployment options please see our 1Password/scim-examples repository.

Installation guide

Install Helm

Install the latest version of Helm. See installing Helm from the official Helm documentation.

Add repository

helm repo add 1password https://1password.github.io/op-scim-helm
helm repo update

Install chart

helm install my-release 1password/op-scim-bridge

Uninstall chart

helm uninstall my-release

Available charts

1Password SCIM bridge

Resource Recommendations

The default resource recommendations for the SCIM bridge and Redis deployments are acceptable in most scenarios, but they fall short in high volume deployments where there is a large number of users and/or groups.

Our current default resource requirements (defined in values.yaml) are:

requested:
  cpu: 125m
  memory: 256M

limits:
  cpu: 250m
  memory: 512M

Proposed recommendations for high volume deployments:

requested:
  cpu: 0.5 (500m)
  memory: 512M

limits:
  cpu: 1 (1000m)
  memory: 1024M

This proposal is 4x the CPU and 2x the memory of the default values.

Updating resources

Updating the default values is a two-step process:

Create a new file named override.yaml in the root directory of the op-scim-helm project, and copy the below content in this new file. We have provided the proposed recommendations for you.

# scim configuration options
scim:
  # resource sets the requests and/or limits for the SCIM bridge pod
  resources:
    requests:
      cpu: 500m
      memory: 512M
    limits:
      cpu: 1000m
      memory: 1024M

Upgrade the op-scim-bridge chart with the updated override.yaml values:

helm upgrade -f override.yaml op-scim-bridge 1password/op-scim-bridge

If successful, you should see the message Release "op-scim-bridge" has been upgraded. Happy Helming!

You can verify the changes by describing the deployment with kubectl and referencing the Limits and Requests sections of the op-scim-bridge container:

kubectl describe deploy op-scim-bridge

For further understanding of how Kubernetes measures resources, please see Resource units in Kubernetes

Please reach out to our support team if you need help with the configuration or to tweak the values for your deployment.

ruimarinho/op-scim-helm