Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCSP-42973-compass-nested-components #671

Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ the upper right of the pipeline builder to open the :guilabel:`Settings` panel.
:pipeline:`$bucket`, and :pipeline:`$bucketAuto` pipeline stages. Lower
limits improve pipeline run time but might result in missing documents.

This setting is only applied to document previews. It is not applied
when the pipeline is run.
This setting is only applied to document previews. It is not applied
when the pipeline is run.
- 100000

Learn More
Expand Down
325 changes: 164 additions & 161 deletions source/connect/advanced-connection-options/in-use-encryption.txt
Original file line number Diff line number Diff line change
Expand Up @@ -61,206 +61,209 @@ Procedure

- :ref:`KMIP <kmip-compass-encryption>`

.. _local-kms:
.. step:: Click Connect.

KMS Provider Links
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
KMS Provider Links
KMS Providers

******************

.. _local-kms:

Local KMS
~~~~~~~~~
Local KMS
~~~~~~~~~

You can locally manage your key as a KMS using the
:v6.0:`Local KMS </core/queryable-encryption/fundamentals/kms-providers/#local-key-provider>`
option.
You can locally manage your key as a KMS using the
:v6.0:`Local KMS </core/queryable-encryption/fundamentals/kms-providers/#local-key-provider>`
option.

Click :guilabel:`Generate Random Key` to generate a 96-byte long
base64-encoded string. You need this key to access encrypted and
decrypted data.
Click :guilabel:`Generate Random Key` to generate a 96-byte long
base64-encoded string. You need this key to access encrypted and
ecrypted data.

.. warning::
.. warning::

|compass-short| does not save KMS credentials by default. Copy
and save the key in an external location.
|compass-short| does not save KMS credentials by default. Copy
and save the key in an external location.

.. _aws-compass-encryption:
.. _aws-compass-encryption:

AWS
~~~
AWS
***

You can use :v6.0:`AWS </core/queryable-encryption/fundamentals/kms-providers/#amazon-web-services-kms>`
to manage your keys.
You can use :v6.0:`AWS </core/queryable-encryption/fundamentals/kms-providers/#amazon-web-services-kms>`
to manage your keys.

Specify the following fields:
Specify the following fields:

.. list-table::
:header-rows: 1
:widths: 30 30 70
.. list-table::
:header-rows: 1
:widths: 30 30 70

* - Field
- Required
- Description
* - Field
- Required
- Description

* - Access Key Id
- Yes
- Value of your AWS access key Id.
* - Access Key Id
- Yes
- Value of your AWS access key Id.

* - Secret Access Key
- Yes
- Value of your AWS secret key.
* - Secret Access Key
- Yes
- Value of your AWS secret key.

* - Session Token
- No
- Value of your AWS session token.
* - Session Token
- No
- Value of your AWS session token.

* - Certificate Authority
- No
- One or more certificate files from trusted Certificate
Authorities to validate the certificate provided by the deployment.
* - Certificate Authority
- No
- One or more certificate files from trusted Certificate
Authorities to validate the certificate provided by the deployment.

* - Client Certificate and Key
- No
- Specifies the location of a local .pem file that contains
either the client's TLS/SSL X.509 certificate or the client's TLS/SSL
certificate and key.
* - Client Certificate and Key
- No
- Specifies the location of a local .pem file that contains
either the client's TLS/SSL X.509 certificate or the client's TLS/SSL
certificate and key.

* - Client Key Password
- No
- If the *Client Private Key* is protected with a password,
you must provide the password.
* - Client Key Password
- No
- If the *Client Private Key* is protected with a password,
you must provide the password.

.. _gcp-compass-encryption:
.. _gcp-compass-encryption:

GCP
~~~
GCP
***

You can use :v6.0:`Google Cloud Services </core/queryable-encryption/fundamentals/kms-providers/#google-cloud-platform-kms>` to manage your keys.
You can use :v6.0:`Google Cloud Services </core/queryable-encryption/fundamentals/kms-providers/#google-cloud-platform-kms>` to manage your keys.

Specify the following fields:
Specify the following fields:

.. list-table::
:header-rows: 1
:widths: 30 30 70
.. list-table::
:header-rows: 1
:widths: 30 30 70

* - Field
- Required
- Description
* - Field
- Required
- Description

* - Service Account Email
- Yes
- The service account email to authenticate.
* - Service Account Email
- Yes
- The service account email to authenticate.

* - Private Key
- Yes
- A base64-encoded private key.
* - Private Key
- Yes
- A base64-encoded private key.

* - Endpoint
- No
- A host with an optional port.
* - Endpoint
- No
- A host with an optional port.

* - Certificate Authority
- No
- One or more certificate files from trusted Certificate
Authorities to validate the certificate provided by the deployment.
* - Certificate Authority
- No
- One or more certificate files from trusted Certificate
Authorities to validate the certificate provided by the deployment.

* - Client Certificate and Key
- No
- Specifies the location of a local .pem file that contains
either the client's TLS/SSL X.509 certificate or the client's TLS/SSL
certificate and key.
* - Client Certificate and Key
- No
- Specifies the location of a local .pem file that contains
either the client's TLS/SSL X.509 certificate or the client's TLS/SSL
certificate and key.

* - Client Key Password
- No
- If the *Client Private Key* is protected with a password,
you must provide the password.
* - Client Key Password
- No
- If the *Client Private Key* is protected with a password,
you must provide the password.


.. _azure-compass-encryption:
.. _azure-compass-encryption:

Azure
~~~~~
Azure
*****

You can use :v6.0:`Azure Key Vault </core/queryable-encryption/fundamentals/kms-providers/#azure-key-vault>`
to manage your keys.
You can use :v6.0:`Azure Key Vault </core/queryable-encryption/fundamentals/kms-providers/#azure-key-vault>`
to manage your keys.

Specify the following fields:
Specify the following fields:

.. list-table::
:header-rows: 1
:widths: 30 30 70
.. list-table::
:header-rows: 1
:widths: 30 30 70

* - Field
- Required
- Description
* - Field
- Required
- Description

* - Tenant Id
- Yes
- Identifies the organization for the account.
* - Tenant Id
- Yes
- Identifies the organization for the account.

* - Client Id
- Yes
- Authenticates a registered application.
* - Client Id
- Yes
- Authenticates a registered application.

* - Client Secret
- Yes
- The client secret to authenticate a registered application.
* - Client Secret
- Yes
- The client secret to authenticate a registered application.

* - Identity Platform Endpoint
- Yes
- A host with an optional port.
* - Identity Platform Endpoint
- Yes
- A host with an optional port.

* - Certificate Authority
- No
- One or more certificate files from trusted Certificate
Authorities to validate the certificate provided by the deployment.
* - Certificate Authority
- No
- One or more certificate files from trusted Certificate
Authorities to validate the certificate provided by the deployment.

* - Client Certificate and Key
- No
- Specifies the location of a local .pem file that contains
either the client's TLS/SSL X.509 certificate or the client's TLS/SSL
certificate and key.

* - Client Key Password
- No
- If the *Client Private Key* is protected with a password,
you must provide the password.

.. _kmip-compass-encryption:

KMIP
~~~~

You can use :v6.0:`KMIP </core/queryable-encryption/fundamentals/kms-providers/#kmip>`
to manage your keys.

.. list-table::
:header-rows: 1
:widths: 30 30 70

* - Field
- Required
- Description

* - Endpoint
- Yes
- The endpoint consists of a hostname and port separated by a colon.

* - Certificate Authority
- No
- One or more certificate files from trusted Certificate
Authorities to validate the certificate provided by the deployment.

* - Client Certificate and Key
- No
- Specifies the location of a local .pem file that contains
either the client's TLS/SSL X.509 certificate or the client's TLS/SSL
certificate and key.

* - Client Key Password
- No
- If the *Client Private Key* is protected with a password,
you must provide the password.

.. step:: (Optional) Specify an EncryptedFieldsMap

Add an optional client-side EncryptedFieldsMap for enhanced security.

For more information, see :v6.0:`Fields for Encryption </core/queryable-encryption/fundamentals/encrypt-and-query/#std-label-qe-fundamentals-encrypt-query>`.

.. step:: Click Connect.
* - Client Certificate and Key
- No
- Specifies the location of a local .pem file that contains
either the client's TLS/SSL X.509 certificate or the client's TLS/SSL
certificate and key.

* - Client Key Password
- No
- If the *Client Private Key* is protected with a password,
you must provide the password.

.. _kmip-compass-encryption:

KMIP
****

You can use :v6.0:`KMIP </core/queryable-encryption/fundamentals/kms-providers/#kmip>`
to manage your keys.

.. list-table::
:header-rows: 1
:widths: 30 30 70

* - Field
- Required
- Description

* - Endpoint
- Yes
- The endpoint consists of a hostname and port separated by a colon.

* - Certificate Authority
- No
- One or more certificate files from trusted Certificate
Authorities to validate the certificate provided by the deployment.

* - Client Certificate and Key
- No
- Specifies the location of a local .pem file that contains
either the client's TLS/SSL X.509 certificate or the client's TLS/SSL
certificate and key.

* - Client Key Password
- No
- If the *Client Private Key* is protected with a password,
you must provide the password.

(Optional) Specify an EncryptedFieldsMap:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
(Optional) Specify an EncryptedFieldsMap:
(Optional) Specify an ``EncryptedFieldsMap``:

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Add an optional client-side EncryptedFieldsMap for enhanced security.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Add an optional client-side EncryptedFieldsMap for enhanced security.
Add an optional client-side ``EncryptedFieldsMap`` for enhanced security.

For more information, see :v6.0:`Fields for Encryption </core/queryable-encryption/fundamentals/encrypt-and-query/#std-label-qe-fundamentals-encrypt-query>`.
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,7 @@ Procedure
- The ``Off`` option initiates a connection :guilabel:`without`
TLS / SSL.

It is recommended that users enable TLS / SSL to avoid security
vulnerabilities.
Enable TLS / SSL to avoid security vulnerabilities.

.. _additional-tls:

Expand Down
Loading