Protegrity Anonymization on

Prerequisites

Mon, 01 Jan 0001 00:00:00 +0000

Ensure the following prerequisites are met:

Tools

Install and configure the following tools on the jumpbox:

opentofu 1.10 or later. For more information about installation steps, refer to OpenTofu Installation.
helm 3.12+, kubectl 1.27+, and aws CLI v2 with access to the Protegrity Provisioned Cluster (PPC).

AWS Setup

Ensure that the following AWS requirements are met:

A Protegrity Provisioned Cluster (PPC) is available. For more information about PPC, refer to Protegrity Provisioned Cluster.

Installing Protegrity Anonymization

Mon, 01 Jan 0001 00:00:00 +0000

Note: This guide uses version 2.0.1 throughout. Replace 2.0.1 with the version you are installing, including in the Python SDK Installation section.

This project deploys the Protegrity Anonymization service on Amazon EKS as part of the Protegrity AI Team Edition.

Deployment Steps

1. Provision Cloud Infrastructure with OpenTofu

The OpenTofu module creates the S3 bucket, IAM role, EKS Pod Identity association, and Karpenter NodePool. It also writes anonymization-values.yaml with cloud-specific Helm overrides.

Configuring Protegrity Anonymization

Mon, 01 Jan 0001 00:00:00 +0000

Warning: Use the -k flag only in development or trusted internal environments. Do not use it in production, where valid certificates must be configured.

Role Update and User Creation

After deployment, update the default anonymization_administrator role to include the can_create_token permission and then create a user with this role.

1. Update `anonymization_administrator` role permission

export GATEWAY_URL="https://$(kubectl get configmap/nfa-config -n default -o jsonpath='{.data.FQDN}')"

# 1. Obtain an Authentication Token
TOKEN=$(curl -sk -X POST "${GATEWAY_URL}/api/v1/auth/login/token" \
 -H 'Content-Type: application/x-www-form-urlencoded' \
 -d 'loginname=admin&password=Admin123!' \
 -D - -o /dev/null | grep -i 'pty_access_jwt_token' | awk '{print $2}' | tr -d '\r\n')

curl -sk -X PUT \
 "${GATEWAY_URL}/pty/v1/auth/roles" \
 -H 'accept: application/json' \
 -H "Authorization: Bearer ${TOKEN}" \
 -H 'Content-Type: application/json' \
 -d '{
 "name": "anonymization_administrator",
 "description": "Administrator role",
 "permissions": [
 "can_create_token",
 "anonymization_operations_admin"
 ]
 }'

2. Create a user with the `anonymization_administrator` role

Use the following request payload when creating the user:

Protegrity Anonymization Python SDK Installation

Mon, 01 Jan 0001 00:00:00 +0000

Use this section to install, configure, and validate the Python SDK for Protegrity Anonymization.

Prerequisites

Ensure one of the following is met:

pip is available in your active Python virtual environment.
A conda environment is activated.

Overview

Use the Python SDK to access the Anonymization service programmatically.

1. Install the Anonymization Python SDK

Install the SDK using pip or conda using the version that matches the deployed Anonymization service.

Using pip:

Uninstallation and Cleanup Protegrity Anonymization

Mon, 01 Jan 0001 00:00:00 +0000

To remove the Anonymization service and all associated Kubernetes and AWS resources:

1. Uninstall the Helm release

# Removes all chart resources. PVC data is RETAINED by default (retentionPolicy: whenDeleted=Retain).
helm uninstall anonymization -n anon-ns

# To also delete the database PVC:
kubectl delete pvc -n anon-ns -l app.kubernetes.io/name=anonymization

Optionally, delete the namespace after the Helm release and PVCs are removed using the following command:

kubectl delete namespace anon-ns

2. Destroy OpenTofu infrastructure

Warning: tofu destroy deletes the S3 bucket, including all stored input and output datasets. Back up any data you need before proceeding.

Protegrity Anonymization on

Prerequisites

Tools

AWS Setup

Installing Protegrity Anonymization

Deployment Steps

1. Provision Cloud Infrastructure with OpenTofu

Configuring Protegrity Anonymization

Role Update and User Creation

1. Update anonymization_administrator role permission

2. Create a user with the anonymization_administrator role

Protegrity Anonymization Python SDK Installation

Prerequisites

Overview

1. Install the Anonymization Python SDK

Uninstallation and Cleanup Protegrity Anonymization

1. Uninstall the Helm release

2. Destroy OpenTofu infrastructure

1. Update `anonymization_administrator` role permission

2. Create a user with the `anonymization_administrator` role