Skip to content

Commit 7e85e21

Browse files
committed
Fix duplication + meta.yaml & index
1 parent 5446d90 commit 7e85e21

17 files changed

+595
-604
lines changed

pages/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -966,6 +966,7 @@
966966
+ [OpenSearch made easy with Index As A Service](platform/logs-data-platform/index_as_a_service)
967967
+ [Follow your logs in real time with ldp-tail](platform/logs-data-platform/ldp_tail)
968968
+ [Keeping your logs for years with the Cold Storage feature](platform/logs-data-platform/cold_storage)
969+
+ [Encrypt your Cold Stored logs](platform/logs-data-platform/cold_storage_encryption)
969970
+ [Using alerts with Logs Data Platform](platform/logs-data-platform/alerting)
970971
+ [Using tokens to query Logs Data Platform](platform/logs-data-platform/tokens_logs_data_platform)
971972
+ [Using Roles to share your data](platform/logs-data-platform/roles)

pages/platform/logs-data-platform/cold_storage_encryption/guide.de-de.md

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,37 @@
11
---
22
title: Encrypt your Cold Stored logs
33
slug: cold-storage-encryption
4+
routes:
5+
canonical: 'https://docs.ovh.com/gb/en/logs-data-platform/cold-storage-encryption/'
46
order: 5
57
excerpt: Secure your Cold Stored logs by encrypting them with your PGP public key
68
section: Features
7-
updated: 2023-03-07
9+
updated: 2023-03-10
810
---
911

10-
**Last updated 7th March, 2023**
12+
**Last updated 10th March, 2023**
1113

1214
## Objective
1315

14-
With the [Cold Storage feature](../cold-storage){.ref} you can generate daily archives for your log streams.
16+
With the [Cold Storage feature](../cold-storage) you can generate daily archives for your log streams.
1517

16-
On top of that you can secure these archives by encrypting them with one or more of your PGP public keys. Only the owner of the private keys will be able to decrypt and see the archives content.
18+
On top of that, you can secure these archives by encrypting them with one or more of your PGP public keys. Only the owner of the private keys will be able to decrypt and see the archives content.
1719

1820
## Requirements
1921

20-
This is what you need to get you started:
22+
This is what you need to get started:
2123

22-
- A stream with cold storage enabled. You can follow this [Cold Storage tutorial](../cold-storage){.ref} to set it up
23-
- An existing PGP keypair, or a machine with the `gpg` binary to generate a new PGP keypair
24+
- A stream with cold storage enabled. You can follow this [Cold Storage tutorial](../cold-storage) to set it up.
25+
- An existing PGP keypair, or a machine with the `gpg` binary to generate a new PGP keypair.
2426

2527
## Instructions
2628

2729
### Get a PGP public key
2830

29-
First of all, you need a PGP keypair. You can use an existing keypair or create a new one. Both cases are documented bellow.
31+
First of all, you need a PGP keypair. You can use an existing keypair or create a new one. Both cases are documented below.
3032
The only restrictions we impose regarding this keypair are:
3133

32-
- use RSA 4096 or ECC with Curve 25519 as public key algorithms
34+
- using RSA 4096 or ECC with Curve 25519 as public key algorithms
3335
- the key must not have any expiration date
3436

3537
> [!warning]
@@ -48,7 +50,7 @@ $ gpg --list-secret-keys
4850
-----------------------
4951
sec ed25519 2023-03-07 [SC]
5052
448940C5335D1D278788F4AF67336C97696A1BE0
51-
uid [ultimate] John Doe <john@doe.org>
53+
uid [ultimate] John Doe <john@smith.org>
5254
ssb cv25519 2023-03-07 [E]
5355
5456
sec rsa3072 2023-03-07 [SC] [expires: 2025-03-06]
@@ -59,15 +61,15 @@ ssb rsa3072 2023-03-07 [E] [expires: 2025-03-06]
5961

6062
We have two keypairs here:
6163

62-
- One for `John Doe <john@doe.org>`, which fingerprint is `448940C5335D1D278788F4AF67336C97696A1BE0`, which is an EdDSA/ECDH key (`ed25519`/`cv25519`), and which don't have any expiration date
64+
- One for `John Smith <john@smith.org>`, which fingerprint is `448940C5335D1D278788F4AF67336C97696A1BE0`, which is an EdDSA/ECDH key (`ed25519`/`cv25519`), and which doesn't have any expiration date
6365
- **This key is usable for Cold Storage Encryption**
6466
- One for `Robert Dupont <[email protected]>`, which fingerprint is `A742F6D3566178F008066E252BE29904DDDA4BA1`, which is an RSA 3072 key, and which expires on `2025-03-06`
6567
- **This key is NOT usable for Cold Storage Encryption**, as it uses RSA < 4096 and has an expiration date
6668

67-
Once you identified a key which match our restrictions, you can export the **public** key in an ASCII armored format with the following command, using its fingerprint:
69+
Once you identified a key which matches our restrictions, you can export the **public** key in an ASCII armored format with the following command, using its fingerprint:
6870

6971
```shell-session
70-
# Replace the fingerprint bellow with the one of your key
72+
# Replace the fingerprint below with the one of your key
7173
$ gpg --armor --export 448940C5335D1D278788F4AF67336C97696A1BE0
7274
-----BEGIN PGP PUBLIC KEY BLOCK-----
7375
@@ -84,7 +86,7 @@ JX2+PZIPN0uhQdsvvF52tQFhags=
8486
-----END PGP PUBLIC KEY BLOCK-----
8587
```
8688

87-
If none of your existing keypairs are compatible, simply generate a new one as explained bellow.
89+
If none of your existing keypairs are compatible, simply generate a new one as explained below.
8890

8991
#### Generate a new PGP public key
9092

@@ -168,16 +170,14 @@ sub cv25519 2023-03-07 [E]
168170

169171
> [!primary]
170172
>
171-
> When you are prompted to choose a passphrase,
172-
> it's up to you to pick one or to leave it empty for no passphrase.
173-
> If you choose to use a passphrase, be sure to store it in some password manager,
174-
> it will be needed to decrypt your archives.
173+
> When you are prompted to choose a passphrase, it's up to you to pick one or to leave it empty for no passphrase.
174+
> If you choose to use a passphrase, be sure to store it in a password manager, it will be needed to decrypt your archives.
175175
>
176176
177177
Congratulations, your key is now generated. You can now export the **public** key in an ASCII armored format with the following command:
178178

179179
```shell-session
180-
# Replace the fingerprint bellow with the one outputed at the end of your key generation
180+
# Replace the fingerprint below with the one from the output at the end of your key generation
181181
$ gpg --armor --export E9136DAF94BD3D708C855124A7109E653C115379
182182
-----BEGIN PGP PUBLIC KEY BLOCK-----
183183
@@ -196,57 +196,56 @@ aMinMlgU3tTxxr1HuldFrFXKcNxfsgdsWNtCBA==
196196

197197
### Register your PGP public key in your Logs Data Platform account
198198

199-
In the home page of your Logs Data Platform service, in the bottom left you will find a `Configuration` panel. In this panel, in the `PGP encryption keys` line, click on **"..."** and then `Edit`{.action}:
199+
In the home page of your Logs Data Platform service, in the bottom left you will find a `Configuration` panel. In this panel, in the `PGP encryption keys` line, click the `...`{.action} button and then `Edit`{.action}:
200200

201201
![Home page](images/home.png){.thumbnail}
202202

203203
You will land on the `PGP encryption keys` page, where you can manage your keys.
204204
It is from this page that you can add, delete, or view the details of your PGP encryption keys. You can also view there how many archives have been encrypted with a given key.
205205

206-
You will possibly view some keys named `LDP Recovery key <cluster name>`, that you did not add yourself. We will talk about these LDP Recovery keys later.
206+
You will possibly view some keys named `LDP Recovery key <cluster name>`, that you did not add yourself. We will mention these LDP Recovery keys later in this documentation.
207207

208208
![PGP keys home page](images/pgp_home.png){.thumbnail}
209209

210-
To register your PGP public key to your Logs Data Platform account, click on the `Add a PGP encryption key`{.action} button.
211-
You will land on a form where you have three fields to fill:
210+
To register your PGP public key into your Logs Data Platform account, click on the `Add a PGP encryption key`{.action} button.
211+
You will land on a form in which you have three fields to fill in:
212212

213-
- **Name**: it is the display name of this PGP public key inside OVHcloud systems. It can be the same as your PGP key UID (usualy `First name Last name <email>`), but it can also be something totaly different. As it's only a display name, put whatever is relevant for you
214-
- **Fingerprint**: your PGP key fingerprint, in its 40 characters hexadecimal version. In the example above where we generated a new key, it is `E9136DAF94BD3D708C855124A7109E653C115379`
215-
- **Content**: the ASCII armored content of your PGP **public** key. Copy paste here the full block beginning with `-----BEGIN PGP PUBLIC KEY BLOCK-----` and ending by `-----END PGP PUBLIC KEY BLOCK-----`
213+
- **Name**: it is the display name of this PGP public key inside OVHcloud systems. It can be the same as your PGP key UID (usually `First name Last name <email>`), but it can also be something totally different. As it's only a display name, enter whatever is relevant for you.
214+
- **Fingerprint**: your PGP key fingerprint, in its 40 characters hexadecimal version. In the example above in which we generated a new key, it is `E9136DAF94BD3D708C855124A7109E653C115379`.
215+
- **Content**: the ASCII armored content of your PGP **public** key. Copy paste here the full block beginning with `-----BEGIN PGP PUBLIC KEY BLOCK-----` and ending by `-----END PGP PUBLIC KEY BLOCK-----`.
216216

217-
Even if the fingerprint can be deducted from the PGP public key content, we want you to specify both so we are 100% sure you are adding the correct key.
217+
Even if the fingerprint can be deducted from the PGP public key content, we want you to specify both so that we are 100% sure you are adding the correct key.
218218

219219
![Add a new PGP key](images/add_key.png){.thumbnail}
220220

221-
Then click on `Save`{.action}.
221+
Then click `Save`{.action}.
222222

223-
If anything is wrong with your public key (unsuported algorithm, mismatch between fingerprint & key content, etc.) a precise error will be printed.
223+
If anything is wrong with your public key (unsupported algorithm, mismatch between fingerprint & key content, etc.) an explicit error message will be printed.
224224

225225
### Update your stream Cold Storage configuration to use encryption
226226

227227
Now that you added your PGP public key to your Logs Data Platform account, you can use it in your streams cold storage configurations.
228228

229-
For this, go to the `Data Stream` tab, pick the stream for which you want cold storage encryption, click on **"..."** and then `Edit`{.action}.
229+
For this, go to the `Data Stream` tab, pick the stream for which you want cold storage encryption, click the `...`{.action} button and then click`Edit`{.action}.
230230

231-
- Ensure the `Enable long-term storage` option is checked. You can refer to the [Cold Storage feature](../cold-storage){.ref} documentation to know about each of its fields.
231+
- Ensure the `Enable long-term storage` option is checked. You can refer to the [Cold Storage feature](../cold-storage) documentation to know about each of its fields.
232232
- Check the `Encrypt archives with my PGP encryption keys` option
233233
- Select each PGP encryption key you want your archive to be encrypted with
234234
- Click on `Save`{.action}
235235

236236
![Update stream configuration](images/update_stream.png){.thumbnail}
237237

238-
That's it: now each archive produced by this stream will be encrypted with the selected keys (don't forget that archives are produced 2 days after logs are sends).
238+
That's it: now each archive produced by this stream will be encrypted with the selected keys (don't forget that archives are produced 2 days after logs are sent).
239239

240240
> [!primary]
241241
>
242-
> For a given stream, you can select up to five of your encryption keys
243-
> (the LDP Recovery Keys are not included in this five keys).
244-
> A given encryption key can be used in several coldstorage configurations.
242+
> For a given stream, you can select up to five of your encryption keys (the LDP Recovery Keys are not included in this five keys).
243+
> A given encryption key can be used in several cold storage configurations.
245244
>
246245
247246
### Know which key was used to encrypt which archive
248247

249-
In the `Data Stream` tab, you can see how many archives exist for each stream. On a stream where you have some archives, click on **"..."** and then `Archives`{.action}
248+
In the `Data Stream` tab, you can see how many archives exist for each stream. On a stream on which you have some archives, click the`...`{.action} button and then click `Archives`{.action}.
250249

251250
![List archives](images/archives.png){.thumbnail}
252251

@@ -258,15 +257,15 @@ In this archives list, you can see a `PGP encryption keys` column.
258257
#### Download and decrypt your archives
259258

260259
Once your encrypted archives are available, you can retrieve them [following this tutorial](../cold-storage/#retrieving-the-archives).
261-
To decrypt a given archive, you can use `gpg` on a machine where your private key is present:
260+
To decrypt a given archive, you can use `gpg` on a machine on which your private key is present:
262261

263262
```shell-session
264263
$ ls
265264
2022-11-15.zst.pgp
266265
267266
$ gpg --output 2022-11-15.zst --decrypt 2022-11-15.zst.pgp
268267
gpg: encrypted with 4096-bit RSA key, ID 97B70793B8270D80, created 2022-05-10
269-
"John Doe <john.doe@corp.acme.org>"
268+
"John Doe <john.smith@corp.acme.org>"
270269
271270
$ ls
272271
2022-11-15.zst 2022-11-15.zst.pgp
@@ -275,21 +274,22 @@ $ ls
275274
### The LDP Recovery Key
276275

277276
Now your stream's archives are encrypted with your PGP public keys, and only the owner of the related private keys can decrypt the archives.
277+
278278
But what if you lose access to your private keys or to your passphrase ? In such a case, you won't be able to decrypt your archives anymore, and won't be able to see the archives content.
279279

280-
To avoid such a situation, we provide the `LDP Recovery Keys`. These are also PGP public keys you can use in your coldstorage configuration, but which private keys are owned by OVHcloud. Thus if you choosed to use `LDP Recovery Keys` in addition to your own keys, and you lose access to your private keys, OVHcloud teams will still be able to decrypt your archives; re-encrypt it with your new keys; and send you these re-encrypted archives.
280+
To avoid such a situation, we provide the `LDP Recovery Keys`. These are also PGP public keys you can use in your cold storage configuration, but which private keys are owned by OVHcloud. Thus if you chose to use `LDP Recovery Keys` in addition to your own keys, and you lose access to your private keys, OVHcloud teams will still be able to decrypt your archives, re-encrypt it with your new keys and send you these re-encrypted archives.
281281

282-
Note that this feature is opt-in: you have to explicitly select the `LDP Recovery Key` in your stream's coldstorage configuration to benefit from this feature.
282+
Note that this feature is opt-in: you have to explicitly select the `LDP Recovery Key` in your stream's cold storage configuration to benefit from this feature.
283283

284284
#### Ask OVHcloud to recover your encrypted archive
285285

286-
If the situation described above happens (you lost your private key, but your archive is also encrypted with the `LDP Recovery Key`), you will have to [contact OVHcloud support](https://www.ovhcloud.com/de/contact/). Open a ticket and describe precisely the name of your Logs Data Platform service, the name of the stream and the name of the archive. You will also have to provide a new PGP encryption key (a one you already added to your Logs Data Platform account).
286+
If the situation described above happens (you lost your private key, but your archive is also encrypted with the `LDP Recovery Key`), you will have to [contact OVHcloud support](https://www.ovhcloud.com/en/contact/). Open a ticket and describe precisely the name of your Logs Data Platform service, the name of the stream and the name of the archive. You will also have to provide a new PGP encryption key (a key you already added to your Logs Data Platform account).
287287

288288
The Logs Data Platform team will then take care of your request.
289289

290290
## Go further
291291

292-
- Getting Started: [Quick Start](../quick-start){.ref}
293-
- Documentation: [Guides](../){.ref}
292+
- Getting Started: [Quick Start](../quick-start)
293+
- Documentation: [Guides](../)
294294
- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms){.external}
295295
- Create an account: [Try it!](https://www.ovh.com/de/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs)){.external}

pages/platform/logs-data-platform/cold_storage_encryption/guide.en-asia.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,13 +129,13 @@ Please select which elliptic curve you want:
129129
Your selection? 1
130130
131131
Please specify how long the key should be valid.
132-
0 = key smiths not expire
132+
0 = key does not expire
133133
<n> = key expires in n days
134134
<n>w = key expires in n weeks
135135
<n>m = key expires in n months
136136
<n>y = key expires in n years
137137
Key is valid for? (0) 0
138-
Key smiths not expire at all
138+
Key does not expire at all
139139
140140
Is this correct? (y/N) y
141141

0 commit comments

Comments
 (0)