Skip to content

Commit 15a50d1

Browse files
authored
Merge pull request #1784 from EnterpriseDB/release/2021-08-21
2 parents db765c7 + 7ba2bde commit 15a50d1

24 files changed

+110
-134
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,9 @@ If you experience errors or other issues with the site, try the following in the
138138

139139
## Development
140140

141-
All changes should have a pull request opened against the default branch, `develop`. When a pull request is opened, Heroku should automatically create a review build, which should be linked in the pull request under "deployments". Review builds only include advocacy content. When a pull request is merged, `develop` will automatically deploy the changes to the staging environment.
141+
All changes should have a pull request opened against the default branch, `develop`. To generate [#draft-deployments](Draft deployments) for the branch, add the `deploy` label to the pull request: a new deployment at a unique URL will be produced every time changes are pushed to the branch. Note: GitHub must be able to merge the branch cleanly in order for this to work; if there are conflicts shown on the pull request, resolve them in order to obtain a new draft deployment.
142+
143+
When a PR is merged into the `develop` branch, the result will be deployed to the [staging](#staging) environment.
142144

143145
To deploy to production, create a pull request merging `develop` into `main`. When that PR is merged, `main` will automatically build and deploy to the production site.
144146

@@ -150,13 +152,17 @@ Deployments of the site use the `build-sources.json` file to determine which sou
150152

151153
Staging is hosted on Netlify, and is built from the `develop` branch. The build and deployment process is handled by the `deploy-develop.yml` GitHub workflow.
152154

155+
Staging environment URL: https://edb-docs-staging.netlify.app/docs/
156+
153157
#### Production
154158

155159
Production is hosted on Netlify, and is built from the `main` branch. The build and deployment process is handled by the `deploy-main.yml` GitHub workflow. The production deployment process will update the search index on Algolia.
156160

157-
#### Review Builds
161+
Production environment URL: https://www.enterprisedb.com/docs
162+
163+
#### Draft deployments
158164

159-
Review builds are automatically created for pull requests. These builds are created by Heroku, and only include advocacy content, no other sources.
165+
Review builds are automatically created for pull requests when the `deploy` tag is added. The build and deployment process is handled by the `deploy-draft.yml` GitHub workflow. Draft builds are [a Netlify feature](https://docs.netlify.com/cli/get-started/#draft-and-production-deploys) - each new draft has a unique URL (based on the Staging URL) that will persist even when later revisions are deployed.
160166

161167
## Redirects
162168

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
22
title: 'Partner Information'
3-
description: 'Providing a general overview of Thales and the CipherTrust Transparent Encryption product'
3+
description: 'Overview of Thales and the CipherTrust Transparent Encryption product'
44

55
---
6+
67
|   |   |
78
| ----------- | ----------- |
89
| **Partner Name** | Thales |
910
| **Partner Product** | CipherTrust Transparent Encryption |
1011
| **Web Site** | https://cpl.thalesgroup.com/encryption |
11-
| **Version & Platform** | 7.1.0, Available platforms: Windows , Linux |
12-
| **Product Description** | CipherTrust Transparent Encryption delivers data-at-rest encryption with centralized key management privileged user access control and detailed data access audit logging. This protects data wherever it resides, on- premises, across multiple clouds and within big data, and container environments. |
12+
| **Version & Platform** | 7.1.0, Available platforms: Windows, Linux |
13+
| **Product Description** | CipherTrust Transparent Encryption (CTE) delivers data-at-rest encryption with centralized key management, privileged user access control, and detailed data access audit logging. This protects data wherever it resides: on-premises, across multiple clouds and within big data, and container environments. |
Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
---
22
title: 'Solution Summary'
3-
description: 'A brief explanation of the solution and its purpose'
3+
description: 'Brief explanation of the solution and its purpose'
44
---
5-
Thales CipherTrust Transparent Encryption (CTE) is designed to meet data security compliance and best practice requirements with minimal disruption. The CTE agents are installed at the operating file-system or device layer, and encryption and decryption is transparent to all applications that run above it. CTE agents are installed on EDB Postgres Advanced and Postgres Extended database servers and protect the database directories. The solution works in conjunction with the FIPS 140-2 up to Level 3 compliant CipherTrust Manager, which centralizes encryption key and policy management for the CipherTrust Data Security Platform.
5+
6+
7+
Thales’ CipherTrust Transparent Encryption secures data at-rest for Postgres databases and backups
8+
with file system-level encryption backed by centralized key management, privileged user access controls, and
9+
detailed data access audit logging. CipherTrust Transparent Encryption allows customers to adopt Postgres
10+
for highly-sensitive and regulated data both on-premises and in the cloud while also meeting their compliance
11+
obligations. CipherTrust Transparent Encryption has been certified with EDB Postgres Advanced,
12+
and with EDB Postgres Extended as part of a BDR (bi-directional replication) cluster, and with Barman.
613

714
<p align="center">
815
<img src="Images/SolutionSummary.jpg.png">
@@ -11,4 +18,4 @@ Thales CipherTrust Transparent Encryption (CTE) is designed to meet data securit
1118

1219

1320
!!! Note
14-
EDB Postgres Extended with BDR (Bi-Directional Replication)
21+
EDB Postgres Extended represents EDB Postgres Extended* with BDR (Bi-Directional Replication) and Barman.

advocacy_docs/partner_docs/ThalesGuide/04-ImplementingCTE.mdx

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
11
---
22
title: 'Implementing CipherTrust Transparent Encryption (CTE)'
3-
description: 'A walk-through of setting up CTE'
3+
description: 'Walkthrough of setting up CTE'
44
---
55

6-
Implementing the CipherTrust Transparent Encryption (CTE) solution requires the following components:
6+
**Implementing the CipherTrust Transparent Encryption (CTE) solution requires the following components:**
77

8-
1. Postgres Server installed and in operation.
8+
- Postgres server installed and operational.
9+
- CipherTrust Manager installed and operational.
10+
- A CTE agent installed on the Postgres host registered to the CipherTrust Manager.
911

10-
2. CipherTrust Manager installed and operational.
1112

12-
3. A CTE agent installed on the Postgres host registered to the CipherTrust Manager.
13-
14-
15-
The following diagram shows the basic flow of the CTE solution:
13+
**The following diagram shows the basic flow of the CTE solution:**
1614

1715
<p align="center">
1816
<img src="Images/ImplementingCTE.png">
1917
</p>
2018

21-
### Prerequisites
19+
### 3.1 Prerequisites
2220
#### Postgres Host
23-
1. Ensure that the Postgres Server is installed and running.
21+
1. Ensure that the Postgres server is installed and running.
2422

2523
2. For CentOS 7, you need to install the following repository:
2624

@@ -35,25 +33,30 @@ sudo yum install -y lsof
3533
<img src="Images/CipherTrustManager.png">
3634
</p>
3735

38-
### Configuring CipherTrust Manager
36+
### 3.2 Configuring CipherTrust Manager
3937
Logon to the CipherTrust Manager (CM) Web GUI and perform the following steps:
4038

41-
1. **Create Registration Token**
39+
1. Create a registration token.
40+
41+
a. Navigate to **Key and Access Management** and select **Registration Tokens**. This token is used for the CTE agent enrollment to CM.
4242

43-
a. Navigate to **Key and Access Management** and select **Registration Tokens**. This token will be used for the CTE agent enrollment to CM.
43+
b. Select **New Registration Token** to create a new registration token.
44+
4445

45-
b. Select **New Registration Token** to create a new Registration Token. The following screenshot shows a Registration Token created with the name **edb**.
46+
The following screenshot shows a registration token created with the name **edb**.
4647

4748

4849
<p align="center">
4950
<img src="Images/ConfiguringCipherTrustManager.png">
5051
</p>
5152

52-
2. **Create User Sets**
53+
2. Create user sets.
5354

54-
a. Navigate to **CTE** and select **Policies, Policy Elements** and then **User Sets**.
55+
a. Navigate to CTE and select Policies, Policy Elements and then User Sets.
5556

56-
b. Select **Create User Set** to create a new User Set. The following screenshots show the User Sets created, **Postgres, EnterpriseDB and Barman**.
57+
b. Select Create User Set to create a new user set.
58+
59+
Create the Postgres, EnterpriseDB and Barman user sets as shown in the following screenshots.
5760

5861

5962
<p align="center">
@@ -70,7 +73,8 @@ Logon to the CipherTrust Manager (CM) Web GUI and perform the following steps:
7073

7174
a. Navigate back to **Policies** and select **Create Policy**.
7275

73-
b. The following screenshots show Live Data Transformation (LDT) policies **postgres-policy, epas-policy and barman-policy**.
76+
77+
**The following screenshots show Live Data Transformation (LDT) policies postgres-policy, epas-policy and barman-policy.**
7478

7579

7680
<p align="center">
@@ -90,21 +94,23 @@ Logon to the CipherTrust Manager (CM) Web GUI and perform the following steps:
9094
<img src="Images/CreatePolicies4.png">
9195
</p>
9296

93-
### Installing CTE Agent
97+
### 3.3 Installing CTE Agent
9498

9599
Refer to the following guides from Thales for installing the CTE agent on the Postgres host:
96100

97101
[CTE Agent Quick Start Guide](https://thalesdocs.com/ctp/cte/Books/Online-Files/7.0.0/CTE_Agent_Linux_Quick_Start_Guide_v7.0.0_Doc_v1.pdf)
98102

99-
[CTE Agent Advanced Installation Guide](https://thalesdocs.com/ctp/cte/Books/Online-Files/7.0.0/CTE_Agent_Linux_Adv_Config_Integration_Guide_v7.0.0_Doc_v6.pdf)
103+
[*CTE Agent Advanced Installation Guide*](https://thalesdocs.com/ctp/cte/Books/Online-Files/7.0.0/CTE_Agent_Linux_Adv_Config_Integration_Guide_v7.0.0_Doc_v6.pdf)
100104

101105
!!! Note
102-
You will need the **Registration Token** and host address of the **CipherTrust Manager** during the installation.
106+
You will need the Registration Token and host address of the CipherTrust Manager during the installation.
103107

104108
After the CTE agent is successfully installed, verify the Postgres host is registered with CM.
105109
1. Log on to the CM Web GUI and navigate to **CTE**.
106110
2. Select **Clients**. The client status should appear as **Healthy** as shown below (you may have to wait a few seconds for the status to get updated).
107111

112+
The following screenshot shows clients registered with the CipherTrust Manager.
113+
108114
<p align="center">
109115
<img src="Images/InstallingCTEAgent.png">
110-
</p>
116+
</p>

advocacy_docs/partner_docs/ThalesGuide/05-UsingCTE.mdx

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
---
22
title: 'Using CipherTrust Transparent Encryption (CTE)'
3-
description: 'Walking through multiple different instances of CTE in use'
3+
description: 'Walkthroughs of multiple CTE usage scenarios '
44
---
55

66
CTE protects data either at the file level or at the storage device level. A CTE Agent running on the (Postgres) host manages the files behind a GuardPoint by enforcing the policy associated with it, and communicates data access events to the CipherTrust Manager for logging. A GuardPoint is usually associated with a Linux mount point or a Windows volume, but may also be associated with a directory subtree.
77

8+
**The following diagram shows the CTE architecture.**
9+
810
<p align="center">
911
<img src="Images/UsingCTE.png">
1012
</p>
1113

12-
### Sample User Scenarios
14+
### 4.1 Sample User Scenarios
1315

14-
This section describes sample user scenarios of deploying CTE solutions on Postgres hosts such as
15-
- EDB Postgres Advanced Server
16-
- EDB Postgres Extended with BDR
16+
This section describes sample user scenarios of deploying CTE solutions on EDB Postgres Advanced Server and EDB Postgres Extended with BDR hosts.
17+
- **EDB Postgres Advanced Server**
18+
- **EDB Postgres Extended with BDR**
1719

18-
**EDB Postgres Advanced Server 13 (Single Instance)**
20+
**EDB Postgres Advanced Server (Single Instance)**
1921

2022
1. Install CTE agent on the Postgres host.
2123
2. Login to the Postgres host and stop the postgres server.
22-
3. Create the GuardPoints via the CM Web GUI using the **epas-policy** Policy on the postgres host. Set the following directories as the **Protected Path** on the EPAS host (assuming PGDATA is set /var/lib/edb/as13/data on the host):
24+
3. Create the GuardPoints via the CM Web GUI using the **epas-policy** Policy on the postgres host. Set the following directories as the **Protected Path** on the EDB Postgres Advanced Server host (assuming PGDATA is set /var/lib/edb/as13/data on the host):
25+
2326
<p align="center">
2427
<img src="Images/SampleUserScenarios1.png">
2528
</p>
@@ -34,10 +37,10 @@ The following diagram shows the BDR-Always-ON architecture. For more details, re
3437
The documentation requires EDB access credentials.
3538

3639
<p align="center">
37-
<img src="Images/SampleUserScenarios2.png">
40+
<img src="Images/EDBPostgresExtendedwithBDRAlwaysOn.png">
3841
</p>
3942

40-
1. Install CTE agents on all the Postgres and barman nodes.
43+
1. Install CTE agents on all the postgres and barman nodes.
4144

4245
2. Create a GuardPoint via the CM Web GUI using the `barman-policy` Policy on the directory `/var/lib/barman/<server-name>` on the barman node in data center A (DC A). The following screenshot shows a GuardPoint created for the barman node.
4346

@@ -63,10 +66,10 @@ The following diagram shows the BDR-Always-ON architecture. For more details, re
6366

6467
11. Restart the Postgres server on the Lead Master node as the user `postgres`. Make sure you are logged in using ssh (not sudo).
6568

66-
12. The following screenshot shows a GuardPoint created for Lead Master in data center A.
69+
The following screenshot shows a GuardPoint created for Lead Master in data center A.
6770

6871
<p align="center">
6972
<img src="Images/SampleUserScenarios4.png">
7073
</p>
7174

72-
13. Repeat steps 2 through 11 for postgres and barman nodes in data center B (DC B).
75+
12. Repeat steps 2 through 11 for postgres and barman nodes in data center B (DC B).
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
title: 'Certification Environment'
3-
description: 'Providing a general overview of the certification environment used in the implementation of CTE'
3+
description: 'Overview of the certification environment used in the implementation of CTE'
44
---
55

66
| &nbsp; | &nbsp; |
77
| ----------- | ----------- |
88
| **Certification Test Date** | May 19 2021 |
9+
| **EDB Advanced Server** | 13.2.5 |
910
| **OS** | CentOS Linux 7 (Core) |
1011
| **Memory** | 2G |
1112
| **Processor** | Intel® Xeon® Processor SP Family (“Skylake”) |
@@ -15,15 +16,14 @@ description: 'Providing a general overview of the certification environment used
1516
| **Socket(s)** | 1 |
1617
| **Storage** | 80 GB |
1718
| **CipherTrust Transparent Encryption** | 7.0.0.99 |
18-
| **EDB Advanced Server** | 13.2.5 |
1919

2020
| &nbsp; | &nbsp; |
2121
| ----------- | ----------- |
2222
| **Certification Test Date**| May 19 2021 |
23+
| **EDB Postgres Extended with BDR** | 3.6.1 |
2324
| **OS**| CentOS Linux 7 |
2425
| **Cloud Platform**| AWS |
2526
| **Deployment Tool**| tpaexec v20.11 |
26-
| **BDR-Always-ON**| 3.6.1 |
2727

2828
!!! Note
2929
Refer to the [sample config.yml](07-Appendix.mdx) file in the Appendix for deployment details.

advocacy_docs/partner_docs/ThalesGuide/07-Appendix.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Appendix'
3-
description: 'Utilize the config.yml file below'
3+
description: 'Sample `config.yml` file'
44
---
55

66
### Sample `config.yml` file
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

app.json

Lines changed: 0 additions & 37 deletions
This file was deleted.

gatsby-config.js

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -71,34 +71,32 @@ const sourceToPluginConfig = {
7171
const externalSourcePlugins = () => {
7272
const sourcePlugins = [];
7373

74-
if (!process.env.SKIP_SOURCING) {
75-
// default to full set of sources
76-
let sources = Object.keys(sourceToPluginConfig).reduce((result, source) => {
77-
result[source] = true;
78-
return result;
79-
}, {});
74+
// default to full set of sources
75+
let sources = Object.keys(sourceToPluginConfig).reduce((result, source) => {
76+
result[source] = true;
77+
return result;
78+
}, {});
8079

81-
if (gracefulFs.existsSync(sourceFilename)) {
82-
console.log(
83-
`${ANSI_BLUE}###### Sourcing from ${sourceFilename} #######${ANSI_STOP}`,
84-
);
85-
console.log(
86-
`${ANSI_GREEN}Note: ${sourceFilename} is no longer required; delete it to load the full set of docs.${ANSI_STOP}`,
87-
);
88-
sources = JSON.parse(gracefulFs.readFileSync(sourceFilename));
89-
}
80+
if (gracefulFs.existsSync(sourceFilename)) {
81+
console.log(
82+
`${ANSI_BLUE}###### Sourcing from ${sourceFilename} #######${ANSI_STOP}`,
83+
);
84+
console.log(
85+
`${ANSI_GREEN}Note: ${sourceFilename} is no longer required; delete it to load the full set of docs.${ANSI_STOP}`,
86+
);
87+
sources = JSON.parse(gracefulFs.readFileSync(sourceFilename));
88+
}
9089

91-
for (const [source, enabled] of Object.entries(sources)) {
92-
const config = sourceToPluginConfig[source];
93-
if (enabled && config) {
94-
sourcePlugins.push({
95-
resolve: "gatsby-source-filesystem",
96-
options: {
97-
name: config.name,
98-
path: config.path,
99-
},
100-
});
101-
}
90+
for (const [source, enabled] of Object.entries(sources)) {
91+
const config = sourceToPluginConfig[source];
92+
if (enabled && config) {
93+
sourcePlugins.push({
94+
resolve: "gatsby-source-filesystem",
95+
options: {
96+
name: config.name,
97+
path: config.path,
98+
},
99+
});
102100
}
103101
}
104102

0 commit comments

Comments
 (0)