Skip to content

Commit 9ced758

Browse files
committed
add Private Operator Upgrade Policy
1 parent e702fb9 commit 9ced758

12 files changed

+72
-6
lines changed

docs/guides/integration-options-private-operator.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ hide_table_of_contents: false
66

77
import Link from '@docusaurus/Link';
88

9+
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
10+
911
# UID2 Private Operator Integration Overview
1012

1113
UID2 participants that host their own <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link> send their own first-party <Link href="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link> to their own local UID2 <Link href="../ref-info/glossary-uid#gl-operator">Operator</Link> service, running in a private environment.
@@ -83,6 +85,10 @@ There are a couple of limitations to Private Operator functionality:
8385
- Private Operators do not currently support <Link href="../ref-info/glossary-uid#gl-client-side">client-side integration</Link>.
8486
- Private Operator updates are released three times per year; Public Operator updates are released on a more frequent cadence.
8587

88+
## Private Operator Upgrade Policy
89+
90+
<UpgradePolicy />
91+
8692
## Getting Started
8793

8894
To get started as a Private Operator, follow these steps:

docs/guides/operator-guide-aks-enclave.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ sidebar_position: 18
88
---
99

1010
import Link from '@docusaurus/Link';
11+
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
1112
import ReleaseMatrix from '../snippets/_private-operator-release-matrix.mdx';
1213

1314
# UID2 Private Operator for AKS Integration Guide
@@ -79,6 +80,10 @@ You'll receive separate `{OPERATOR_KEY}` values for each environment. Be sure to
7980
| Integration (`integ`) | For testing only. Debug mode is available in the integration environment. |
8081
| Production (`prod`) | For managing production traffic. |
8182

83+
## Private Operator Upgrade Policy
84+
85+
<UpgradePolicy />
86+
8287
## Deployment
8388

8489
To deploy a new UID2 Private Operator for AKS, you'll need to complete the following high-level steps:

docs/guides/operator-guide-aws-marketplace.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ sidebar_position: 17
88
---
99

1010
import Link from '@docusaurus/Link';
11+
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
1112
import ReleaseMatrix from '../snippets/_private-operator-release-matrix.mdx';
1213
import AttestFailure from '../snippets/_private-operator-attest-failure.mdx';
1314

@@ -162,6 +163,10 @@ To deploy UID2 Operator on AWS Marketplace, complete the following steps:
162163

163164
It takes several minutes for the stack to be created. When you see an Auto Scaling Group (ASG) created, you can select it and check the EC2 instances. By default, there is only one instance to start with.
164165

166+
### Private Operator Upgrade Policy
167+
168+
<UpgradePolicy />
169+
165170
### Operator Version
166171

167172
The latest ZIP file is linked in the Release Notes column in the following table.

docs/guides/operator-guide-azure-enclave.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ sidebar_position: 18
88
---
99

1010
import Link from '@docusaurus/Link';
11+
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
1112
import ReleaseMatrix from '../snippets/_private-operator-release-matrix.mdx';
1213

1314
# UID2 Private Operator for Azure Integration Guide
@@ -93,6 +94,10 @@ The first step is to get set up with the deployment files you'll need:
9394
- `operator.json` and `operator.parameters.json`
9495
- `gateway.json` and `gateway.parameters.json`
9596

97+
### Private Operator Upgrade Policy
98+
99+
<UpgradePolicy />
100+
96101
### Operator Version
97102

98103
The latest ZIP file is linked in the Azure Download column in the following table.

docs/guides/operator-private-gcp-confidential-space.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ sidebar_position: 18
88
---
99

1010
import Link from '@docusaurus/Link';
11+
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
1112
import ReleaseMatrix from '../snippets/_private-operator-release-matrix.mdx';
1213

1314
# UID2 Private Operator for GCP Integration Guide
@@ -87,7 +88,11 @@ When UID2 account registration is complete, and you've installed the gcloud CLI,
8788
- Review information about [deployment environments](#deployment-environments).
8889
- Review information about the [deployment options](#deployment-options) available, including the benefits of each, and decide which to use.
8990

90-
### Operator Versions
91+
### Private Operator Upgrade Policy
92+
93+
<UpgradePolicy />
94+
95+
### Operator Version
9196

9297
The latest ZIP file is linked in the GCP Download column in the following table.
9398

@@ -175,7 +180,7 @@ Install Terraform if it is not already installed: visit [terraform.io](https://w
175180

176181
#### Download the Template Files
177182

178-
Download the ZIP file listed in [Operator Versions](#operator-versions) in the GCP Download column. Be sure to select the latest version. Unzip the files to a convenient location. You will have the files listed in the following table.
183+
Download the ZIP file listed in [Operator Version](#operator-version) in the GCP Download column. Be sure to select the latest version. Unzip the files to a convenient location. You will have the files listed in the following table.
179184

180185
| File | Details |
181186
| :--- | :--- |
@@ -401,7 +406,7 @@ Placeholder values are defined in the following table.
401406
| `{ZONE}` | The Google Cloud zone that the VM instance will be deployed on. |
402407
| `{IMAGE_FAMILY}` | Use `confidential-space` for Integration and Production, `confidential-space-debug` for debugging purposes in Integration only. Note that `confidential-space-debug` will not work in Production. |
403408
| `{SERVICE_ACCOUNT}` | The service account email that you created as part of creating your account, in this format: `{SERVICE_ACCOUNT_NAME}@{PROJECT_ID}.iam.gserviceaccount.com`.<br/>For details, see [Set Up Service Account Rules and Permissions](#set-up-service-account-rules-and-permissions) (Step 4). |
404-
| `{OPERATOR_IMAGE}` | The Docker image URL for the UID2 Private Operator for GCP, used in configuration.<br/>This can be found in the `terraform.tfvars` file in the GCP download file (see [Operator Versions](#operator-versions)). |
409+
| `{OPERATOR_IMAGE}` | The Docker image URL for the UID2 Private Operator for GCP, used in configuration.<br/>This can be found in the `terraform.tfvars` file in the GCP download file (see [Operator Version](#operator-version)). |
405410
| `{OPERATOR_KEY_SECRET_FULL_NAME}` | The full name that you specified for the Operator Key secret (see [Create Secret for the Operator Key in Secret Manager](#create-secret-for-the-operator-key-in-secret-manager)), including the path, in the format `projects/<project_id>/secrets/<secret_id>/versions/<version>`. For example: `projects/111111111111/secrets/uid2-operator-operator-key-secret-integ/versions/1`. |
406411
407412
##### Sample Deployment Script&#8212;Integ
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!-- Used by: All Private Operator guides plus Private Operator overview (guides/integration-options-private-operator.md) -->
2+
3+
To maintain security and operational integrity, outdated operator versions will be disabled after 12 months, which may cause affected deployments to shut down or fail to start. Upgrading ensures the use of the latest security and feature enhancements. We recommend upgrading proactively to avoid disruptions.
4+
5+
:::note
6+
For critical security or operational issues, or where contract terms apply, we reserve the right to enforce tighter upgrade timelines for private operators.
7+
:::

i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-private-operator.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ hide_table_of_contents: false
55
---
66

77
import Link from '@docusaurus/Link';
8+
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
89

910
# UID2 Private Operator Integration Overview
1011

@@ -83,6 +84,10 @@ Private Operator にはいくつかの制限があります:
8384
- Private Operator は、現在、<Link href="../ref-info/glossary-uid#gl-client-side">client-side integration</Link> をサポートしていません。
8485
- Private Operator の更新は、年に 3 回リリースされます; Public Operator の更新は、より頻繁にリリースされます。
8586

87+
## Private Operator Upgrade Policy
88+
89+
<UpgradePolicy />
90+
8691
## Getting Started
8792

8893
Private Operator を開始するには、次の手順に従います:

i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-aks-enclave.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ sidebar_position: 18
88
---
99

1010
import Link from '@docusaurus/Link';
11+
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
1112
import ReleaseMatrix from '../snippets/_private-operator-release-matrix.mdx';
1213

1314
# UID2 Private Operator for AKS Integration Guide
@@ -79,6 +80,11 @@ Kubernetesの `kubectl` コマンドラインインターフェイスをイン
7980
| Integration (`integ`) | テスト専用です。デバックモードはテスト環境で利用可能です。 |
8081
| Production (`prod`) | 本番トラフィックを管理するためのものです。 |
8182

83+
84+
## Private Operator Upgrade Policy
85+
86+
<UpgradePolicy />
87+
8288
## Deployment
8389

8490
AKS の新しい UID2 Private Operator をデプロイするには、次の主要な手順を完了する必要があります:

i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-aws-marketplace.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ sidebar_position: 17
88
---
99

1010
import Link from '@docusaurus/Link';
11+
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
1112
import ReleaseMatrix from '../snippets/_private-operator-release-matrix.mdx';
1213
import AttestFailure from '../snippets/_private-operator-attest-failure.mdx';
1314

@@ -162,6 +163,10 @@ UID2 Operator を AWS Marketplace にデプロイするには、以下の手順
162163

163164
スタックの作成には数分かかります。Auto Scaling Group (ASG) が作成されたら、選択して EC2 インスタンスを確認できます。デフォルトでは、最初は 1 つのインスタンスのみが起動します。
164165

166+
### Private Operator Upgrade Policy
167+
168+
<UpgradePolicy />
169+
165170
### Operator Version
166171

167172
最新の ZIP ファイルは、次の表の Release Notes 欄にリンクされています。

i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-azure-enclave.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ sidebar_position: 18
88
---
99

1010
import Link from '@docusaurus/Link';
11+
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
1112
import ReleaseMatrix from '../snippets/_private-operator-release-matrix.mdx';
1213

1314
# UID2 Private Operator for Azure Integration Guide
@@ -93,6 +94,10 @@ Azure CLI をインストールします。詳細は、Azure ドキュメント
9394
- `operator.json` and `operator.parameters.json`
9495
- `gateway.json` and `gateway.parameters.json`
9596

97+
### Private Operator Upgrade Policy
98+
99+
<UpgradePolicy />
100+
96101
### Operator Version
97102

98103
最新の ZIP ファイルは、次の表の Azure Download 列にリンクされています。

0 commit comments

Comments
 (0)