Skip to content

Commit 97f7ef5

Browse files
Improve formulations.
Converted from getsops/sops@735b941 Co-authored-by: Andrew Block <andy.block@gmail.com> Signed-off-by: Felix Fontein <felix@fontein.de>
1 parent 24a6cf1 commit 97f7ef5

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

content/en/docs/_index.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1756,14 +1756,14 @@ The following top-level keys are supported:
17561756
* `destination_rules`: a list of destination rule objects.
17571757
* `stores`: configuration object for the stores.
17581758
1759-
See the next subsections for how these objects look like.
1759+
The following subsections describe how these properties are used.
17601760
17611761
## Creation rule object
17621762
1763-
A creation rule object has three kind of keys:
1763+
A creation rule object has three types of keys:
17641764
1765-
1. Keys that determine whether the creation rule matches;
1766-
1. Keys that determine the (groups of) identities (keys) to encrypt with;
1765+
1. Keys that determine whether the creation rule matches.
1766+
1. Keys that determine the (groups of) identities (keys) to encrypt with.
17671767
1. Keys that determine which parts of and how a file is encrypted.
17681768
17691769
### Matching
@@ -1843,7 +1843,7 @@ To directly specify a single key group, you can use the following keys:
18431843
To specify a list of key groups, you can use the following key:
18441844
18451845
* `key_groups` (list of key group objects): a list of key group objects.
1846-
See below for how such an object looks like.
1846+
See below for how such a resource should be represented.
18471847
Example:
18481848
18491849
``` yaml
@@ -1881,8 +1881,8 @@ To specify a list of key groups, you can use the following key:
18811881
## Key group object
18821882
18831883
A key group contains multiple identities (keys), similar to a creation rule object.
1884-
Having more than one key group allows to use [Shamir's secret sharing](https://en.wikipedia.org/wiki/Shamir%27s_secret_sharing)
1885-
to split the file's encryption key up into multiple parts,
1884+
Having more than one key group allows for the use of [Shamir's secret sharing](https://en.wikipedia.org/wiki/Shamir%27s_secret_sharing)
1885+
which splits the file's encryption key up into multiple parts,
18861886
requiring more than one identity to access the file.
18871887
18881888
A key group supports the following keys:
@@ -1909,7 +1909,7 @@ A key group supports the following keys:
19091909
aws_profile: foo
19101910
```
19111911
1912-
* `gcp_kms` (list of objects): list of GCP KMS ResourceIDs.
1912+
* `gcp_kms` (list of objects): list of GCP KMS resource IDs.
19131913
Every object must have the following key:
19141914
19151915
* `resource_id` (string): the resource ID.
@@ -1949,20 +1949,20 @@ A key group supports the following keys:
19491949
19501950
* `merge`: a list of key group objects.
19511951
These will be merged (by concatenating the keys of the same type) into this key group.
1952-
This key is only there to allow concatenation of key groups using YAML anchors, aliases, and overrides.
1952+
This property allows for the concatenation of key groups using YAML anchors, aliases, and overrides.
19531953
19541954
### Settings
19551955
19561956
The following keys configure encryption settings:
19571957
19581958
* `shamir_threshold` (integer, default `0`): Must be `0` (disabled) or an integer greater or equal to 2.
1959-
Determines the number of key groups from whose one key must be present each to decrypt the file's key.
1959+
Determines the number of key groups that must be present each to decrypt the file's key.
19601960
19611961
* `mac_only_encrypted` (boolean, default `false`): If set to `true`, only encrypted strings will count towards the file's MAC.
1962-
If set to `false`, also unencrypted values will be part of the MAC computation.
1962+
If set to `false`, unencrypted values will also be part of the MAC computation.
19631963
1964-
The following keys configure which values in a file are encrypted.
1965-
Note that at most one of these keys can be used.
1964+
The following keys configure the specific values in a file that should be encrypted.
1965+
Note that at most, one of these keys can be used.
19661966
19671967
* `unencrypted_suffix` (string): A value is encrypted if its key **does not** end with this suffix.
19681968
All other values are **encrypted**.

0 commit comments

Comments
 (0)