Skip to content

Commit

Permalink
Merge pull request #316 from IABTechLab/gwh-APIDOCS-1770-operator-doc…
Browse files Browse the repository at this point in the history
…s-consistent-naming

standardize names for Private Operator products
  • Loading branch information
genwhittTTD authored Oct 9, 2023
2 parents dad4391 + 639421b commit 04058b1
Show file tree
Hide file tree
Showing 19 changed files with 47 additions and 50 deletions.
2 changes: 1 addition & 1 deletion api-ja/v2/guides/operator-guide-aws-marketplace.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
このページは移動しました。新しい場所は Unified ID のウェブサイトです: [UID2 Operator: AWS Marketplace Integration Guide](https://unifiedid.com/ja/docs/guides/operator-guide-aws-marketplace).
このページは移動しました。新しい場所は Unified ID のウェブサイトです: [UID2 Private Operator for AWS Integration Guide](https://unifiedid.com/ja/docs/guides/operator-guide-aws-marketplace).
2 changes: 1 addition & 1 deletion api-ja/v2/guides/operator-guide-azure-enclave.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
このページは移動しました。新しい場所は Unified ID のウェブサイトです: [Microsoft Azure Confidential Compute Operator Package](https://unifiedid.com/ja/docs/guides/operator-guide-azure-enclave).
このページは移動しました。新しい場所は Unified ID のウェブサイトです: [UID2 Private Operator for Azure Integration Guide](https://unifiedid.com/ja/docs/guides/operator-guide-azure-enclave).
2 changes: 1 addition & 1 deletion api/v2/guides/operator-guide-aws-marketplace.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
This page has been moved. The new location is on the Unified ID website: [UID2 Operator - AWS Marketplace Integration Guide](https://unifiedid.com/docs/guides/operator-guide-aws-marketplace).
This page has been moved. The new location is on the Unified ID website: [UID2 Private Operator for AWS Integration Guide](https://unifiedid.com/docs/guides/operator-guide-aws-marketplace).
2 changes: 1 addition & 1 deletion api/v2/guides/operator-guide-azure-enclave.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
This page has been moved. The new location is on the Unified ID website: [Microsoft Azure Confidential Compute Operator Package](https://unifiedid.com/docs/guides/operator-guide-azure-enclave).
This page has been moved. The new location is on the Unified ID website: [UID2 Private Operator for Azure Integration Guide](https://unifiedid.com/docs/guides/operator-guide-azure-enclave).
18 changes: 9 additions & 9 deletions docs/guides/operator-guide-aws-marketplace.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: UID2 Operator - AWS Marketplace Integration
title: UID2 Private Operator for AWS Integration Guide
sidebar_label: AWS Marketplace
pagination_label: UID2 Operator - AWS Marketplace Integration
pagination_label: UID2 Private Operator for AWS Integration Guide
description: Integration information for Private Operator in AWS.
hide_table_of_contents: false
sidebar_position: 17
---

# UID2 Operator—AWS Marketplace Integration Guide
# UID2 Private Operator for AWS Integration Guide

The UID2 Operator is the API server in the UID2 ecosystem. For a Private Operator service running in AWS Marketplace, the UID2 Operator solution is enhanced with [AWS Nitro](https://aws.amazon.com/ec2/nitro/) Enclave technology. This is an additional security measure to protect UID2 information from unauthorized access.

<!-- This guide includes the following information:
- [UID2 Operator on AWS Marketplace Product](#uid2-operator-on-aws-marketplace-product)
- [UID2 Private Operator for AWS](#uid2-private-operator-for-aws)
- [Prerequisites](#prerequisites)
- [Resources Created](#resources-created)
- [Customization Options](#customization-options)
Expand All @@ -25,15 +25,15 @@ The UID2 Operator is the API server in the UID2 ecosystem. For a Private Operato
- [Upgrading the UID2 Operator](#upgrading-the-uid2-operator)
- [Technical Support](#technical-support) -->

## UID2 Operator on AWS Marketplace Product
## UID2 Private Operator for AWS

>NOTE: [Unified ID 2.0 Operator on AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-wdbccsarov5la) is a free product. The cost displayed on the product page is an estimated cost for the necessary infrastructure.
>NOTE: [UID2 Private Operator for AWS](https://aws.amazon.com/marketplace/pp/prodview-wdbccsarov5la) is a free product. The cost displayed on the product page is an estimated cost for the necessary infrastructure.
By subscribing to the Unified ID 2.0 Operator on AWS Marketplace product, you gain access to the following:
By subscribing to UID2 Private Operator for AWS, you gain access to the following:

- **[Amazon Machine Image (AMI)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html)** with the UID2 Operator service installed and ready to bootstrap:<br/>
- [Amazon Machine Image (AMI)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html) with the UID2 Operator service installed and ready to bootstrap:<br/>
The AMI contains an [Amazon Linux 2](https://aws.amazon.com/amazon-linux-2/?amazon-linux-whats-new.sort-by=item.additionalFields.postDateTime&amazon-linux-whats-new.sort-order=desc) operating system with the UID2 Operator service already set up. When an EC2 instance based on the AMI boots up, it automatically fetches the configuration from your AWS account and starts the UID2 Operator server inside an enclave.
- **[CloudFormation](https://aws.amazon.com/cloudformation/) template**:<br/>
- [CloudFormation](https://aws.amazon.com/cloudformation/) template:<br/>
The template deploys the UID2 Operator AMI.

### Prerequisites
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/operator-guide-azure-enclave.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: UID2 Operator - Microsoft Azure Confidential Compute Operator Package
title: UID2 Private Operator for Azure Integration Guide
sidebar_label: Microsoft Azure
pagination_label: UID2 Operator - Microsoft Azure Confidential Compute Operator Package
pagination_label: UID2 Private Operator for Azure Integration Guide
description: Integration information for Private Operator in Microsoft Azure.
hide_table_of_contents: false
sidebar_position: 18
---

# UID2 Operator&#8212;Microsoft Azure Confidential Compute Operator Package
# UID2 Private Operator for Azure Integration Guide

>IMPORTANT: This documentation is currently only a proof of concept. For additional guidance, [contact](../getting-started/gs-account-setup.md#contact-info) the UID2 administrator.
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/operator-private-gcp-confidential-space.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: UID2 Operator - Google Cloud Platform Confidential Space
title: UID2 Private Operator for GCP Integration Guide
sidebar_label: GCP Confidential Space
pagination_label: UID2 Operator - Google Cloud Platform Confidential Space
pagination_label: UID2 Private Operator for GCP Integration Guide
description: Integration information for Private Operator in GCP.
hide_table_of_contents: false
sidebar_position: 18
---

# UID2 Private Operator&#8212;Google Cloud Platform Confidential Space
# UID2 Private Operator for GCP Integration Guide

This guide provides information for setting up the UID2 Operator Service in [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from [Google Cloud](https://cloud.google.com/docs/overview/) Platform. Confidential Space offers a secure enclave environment, known as a Trusted Execution Environment (TEE).

>NOTE: The UID2 Private Operator implementation for GCP Confidential Space is not supported in these areas: Europe, China.
>NOTE: UID2 Private Operator for GCP is not supported in these areas: Europe, China.
The Operator Service runs in a Confidential Space "workload"&#8212;a containerized Docker image that runs in a secure cloud-based enclave on top of the Confidential Space image.

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/summary-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,6 @@ The following resources are available for Private Operator integrations.

| Integration Guide | Content Description |
| :--- | :--- |
| [UID2 Operator&#8212;AWS Marketplace](operator-guide-aws-marketplace.md) | Instructions for setting up a Private Operator service for AWS Marketplace. |
| [UID2 Private Operator&#8212;Google Cloud Platform Confidential Space](operator-private-gcp-confidential-space.md) | Information for setting up the UID2 Operator Service in [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from [Google Cloud](https://cloud.google.com/docs/overview/) Platform. |
| [UID2 Operator&#8212;Microsoft Azure Confidential Compute Operator Package](operator-guide-azure-enclave.md) | IMPORTANT: This documentation is currently only a proof of concept. For additional guidance, [contact](../getting-started/gs-account-setup.md#contact-info) the UID2 administrator.<br/>Instructions for setting up a Private Operator service for running on Microsoft Azure Confidential Computing platform. |
| [UID2 Private Operator for AWS Integration Guide](operator-guide-aws-marketplace.md) | Instructions for setting up a Private Operator service for AWS Marketplace. |
| [UID2 Private Operator for GCP Integration Guide](operator-private-gcp-confidential-space.md) | Information for setting up the UID2 Operator Service in [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from [Google Cloud](https://cloud.google.com/docs/overview/) Platform. |
| [UID2 Private Operator for Azure Integration Guide](operator-guide-azure-enclave.md) | IMPORTANT: This documentation is currently only a proof of concept. For additional guidance, [contact](../getting-started/gs-account-setup.md#contact-info) the UID2 administrator.<br/>Instructions for setting up a Private Operator service for running on Microsoft Azure Confidential Computing platform. |
6 changes: 3 additions & 3 deletions docs/overviews/overview-operators-private.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ The following documentation resources are available for private operators to imp

| Integration Type| Documentation | Content Description | Audience |
| :--- | :--- | :--- | :--- |
| Operator | [UID2 Operator - AWS Marketplace Integration Guide](../guides/operator-guide-aws-marketplace.md) | Instructions for setting up a Private Operator service for AWS Marketplace. | Private Operators |
| GCP Confidential Space | [UID2 Private Operator&#8212;Google Cloud Platform Confidential Space](../guides/operator-private-gcp-confidential-space.md) | Information for setting up the UID2 Operator Service in [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from [Google Cloud](https://cloud.google.com/docs/overview/) Platform. | Private Operators |
| Azure | [UID2 Operator - Microsoft Azure Confidential Compute Operator Package](../guides/operator-guide-azure-enclave.md) | IMPORTANT: This documentation is currently only a proof of concept. For additional guidance, [contact](../getting-started/gs-account-setup.md#contact-info) the UID2 administrator.<br/>Instructions for setting up a Private Operator service for running on Microsoft Azure Confidential Computing platform. | Private Operators |
| Operator | [UID2 Private Operator for AWS Integration Guide](../guides/operator-guide-aws-marketplace.md) | Instructions for setting up a Private Operator service for AWS Marketplace. | Private Operators |
| GCP Confidential Space | [UID2 Private Operator for GCP Integration Guide](../guides/operator-private-gcp-confidential-space.md) | Information for setting up the UID2 Operator Service in [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from [Google Cloud](https://cloud.google.com/docs/overview/) Platform. | Private Operators |
| Azure | [UID2 Private Operator for Azure Integration Guide](../guides/operator-guide-azure-enclave.md) | IMPORTANT: This documentation is currently only a proof of concept. For additional guidance, [contact](../getting-started/gs-account-setup.md#contact-info) the UID2 administrator.<br/>Instructions for setting up a Private Operator service for running on Microsoft Azure Confidential Computing platform. | Private Operators |

## Getting Started

Expand Down
5 changes: 1 addition & 4 deletions docs/ref-info/glossary-uid.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,7 @@ sidebar_position: 10

<dt class="jump-anchor" id="gl-enclave">Enclave</dt>
<dd>An enclave is a secure subsection of a computing environment. The enclave has additional business logic and security measures applied to it, to prevent anyone from tampering with it.</dd>
<dd>In the context of UID2, a <a href="#gl-private-operator">private operator</a> must run inside an enclave or in a private environment. The enclave versions supported are:<br/>
- <a href="https://aws.amazon.com/ec2/nitro/">AWS Nitro</a>: see <a href="../guides/operator-guide-aws-marketplace">UID2 Operator&#8212;AWS Marketplace Integration Guide</a>.<br/>
- Google Cloud Platform <a href="https://cloud.google.com/confidential-computing#confidential-space">Confidential Space</a>: see <a href="../guides/operator-private-gcp-confidential-space">UID2 Operator&#8212;Google Cloud Platform Confidential Space</a>.<br/>
- <a href="https://learn.microsoft.com/en-us/azure/confidential-computing/">Microsoft Azure confidential computing</a>: see <a href="../guides/operator-guide-azure-enclave">UID2 Operator&#8212;Microsoft Azure Confidential Compute Operator Package</a>.</dd>
<dd>In the context of UID2, a <a href="#gl-private-operator">private operator</a> must run inside an enclave or in a private environment. For a summary of the enclave versions supported, see <a href="../guides/summary-guides#private-operator-service-integrations">Private Operator Service Integrations</a>.</dd>
<dd>In an enclave, the operator image must be a very specific, predefined version, and additional constraints are applied to ensure security.</dd>

<dt class="jump-anchor" id="gl-first-level-hash">First-level hash</dt>
Expand Down
2 changes: 1 addition & 1 deletion docs/ref-info/updates-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Check out the latest updates to our UID2 documentation resources.

This new guide provides information for setting up the UID2 Operator Service in [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from the Google Cloud Platform.

For details, see [UID2 Private Operator&#8212;Google Cloud Platform Confidential Space](../guides/operator-private-gcp-confidential-space.md).
For details, see [UID2 Private Operator for GCP Integration Guide](../guides/operator-private-gcp-confidential-space.md).


### Update: Normalization and Encoding Rules
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: UID2 Operator - AWS Marketplace Integration
title: UID2 Private Operator for AWS Integration Guide
sidebar_label: AWS Marketplace
pagination_label: UID2 Operator - AWS Marketplace Integration
pagination_label: UID2 Private Operator for AWS Integration Guide
description: AWS Marketplace Private Operator のインテグレーション情報。
hide_table_of_contents: false
sidebar_position: 17
---

# UID2 Operator - AWS Marketplace Integration Guide
# UID2 Private Operator for AWS Integration Guide

UID2 Operator は、UID2 エコシステムにおける API サーバーです。AWS Marketplace で稼働する Private Operator サービスの場合、UID2 Operator ソリューションは[AWS Nitro](https://aws.amazon.com/ec2/nitro/) Enclave テクノロジーで強化されています。これは、UID2 情報を不正なアクセスから保護するための追加のセキュリティ対策です。

<!-- This guide includes the following information:
- [UID2 Operator on AWS Marketplace Product](#uid2-operator-on-aws-marketplace-product)
- [UID2 Private Operator for AWS](#uid2-private-operator-for-aws)
- [Prerequisites](#prerequisites)
- [Resources Created](#resources-created)
- [Customization Options](#customization-options)
Expand All @@ -25,9 +25,9 @@ UID2 Operator は、UID2 エコシステムにおける API サーバーです
- [Upgrading the UID2 Operator](#upgrading-the-uid2-operator)
- [Technical Support](#technical-support) -->

## UID2 Operator on AWS Marketplace Product
## UID2 Private Operator for AWS

NOTE: [UID2 Operator on AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-wdbccsarov5la) は無償製品です。製品ページに表示されている費用は、必要なインフラの概算費用となります。
NOTE: [UID2 Private Operator for AWS](https://aws.amazon.com/marketplace/pp/prodview-wdbccsarov5la) は無償製品です。製品ページに表示されている費用は、必要なインフラの概算費用となります。

Unified ID 2.0 Operator on AWS Marketplace 製品を契約することで、以下を利用できます:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: UID2 Operator - Microsoft Azure Confidential Compute Operator Package
title: UID2 Private Operator for Azure Integration Guide
sidebar_label: Microsoft Azure
pagination_label: UID2 Operator - Microsoft Azure Confidential Compute Operator Package
pagination_label: UID2 Private Operator for Azure Integration Guide
description: Microsoft Azure Private Operator のインテグレーション情報。
hide_table_of_contents: false
sidebar_position: 18
---

# Microsoft Azure Confidential Compute Operator Package
# UID2 Private Operator for Azure Integration Guide

>IMPORTANT: このドキュメントは現在、PoC の段階です。詳細は、UID2 Administrator に [連絡](../getting-started/gs-account-setup.md#contact-info) してください。
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: UID2 Operator - Google Cloud Platform Confidential Space
title: UID2 Private Operator for GCP Integration Guide
sidebar_label: GCP Confidential Space
pagination_label: UID2 Operator - Google Cloud Platform Confidential Space
pagination_label: UID2 Private Operator for GCP Integration Guide
description: Integration information for Private Operator in GCP.
hide_table_of_contents: false
sidebar_position: 18
---

# UID2 Private Operator&#8212;Google Cloud Platform Confidential Space
# UID2 Private Operator for GCP Integration Guide

This guide provides information for setting up the UID2 Operator Service in [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from [Google Cloud](https://cloud.google.com/docs/overview/) Platform. Confidential Space offers a secure enclave environment, known as a Trusted Execution Environment (TEE).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ sidebar_position: 01

| Integration Guide | Content Description |
| :----------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [UID2 Operator - Microsoft Azure Confidential Compute Operator Package](./operator-guide-azure-enclave.md) | IMPORTANT: このドキュメントは現在、PoC の段階です。詳細は、UID2 Administrator に [連絡](../getting-started/gs-account-setup.md#contact-info) してください。<br/>Closed Operator Service を Microsoft Azure Confidential Computing プラットフォーム上で動作させるためのセットアップ手順です。 |
| [UID2 Private Operator for Azure Integration Guide](./operator-guide-azure-enclave.md) | IMPORTANT: このドキュメントは現在、PoC の段階です。詳細は、UID2 Administrator に [連絡](../getting-started/gs-account-setup.md#contact-info) してください。<br/>Closed Operator Service を Microsoft Azure Confidential Computing プラットフォーム上で動作させるためのセットアップ手順です。 |
| [UID2 Operator - AWS Marketplace](./operator-guide-aws-marketplace.md) | AWS Marketplace のクローズドオペレーターサービスをセットアップする手順です。  |
<!-- | UID2 Operator - Google Cloud Platform Confidential Compute package | Google Cloud Platform Confidential Compute (GCP) パッケージのセットアップ手順です。 | -->
Loading

0 comments on commit 04058b1

Please sign in to comment.