docs: Remove all traces of "identity.pub" from docs

"identity.pub" is referenced multiple times in CRDs and docs. This secret
is however never used in any place. Instead, the public key is derived from
the "identity" private key.

This commit/PR removes all traces of "identity.pub" from v1beta2 CRDs and
docs.

Signed-off-by: Alexander Block <ablock84@gmail.com>
This commit is contained in:
Alexander Block 2022-04-29 08:23:10 +02:00 committed by Max Jonas Werner
parent 1e83f0ecf5
commit 065a760752
4 changed files with 8 additions and 11 deletions

View File

@ -56,7 +56,7 @@ type GitRepositorySpec struct {
// the GitRepository. // the GitRepository.
// For HTTPS repositories the Secret must contain 'username' and 'password' // For HTTPS repositories the Secret must contain 'username' and 'password'
// fields. // fields.
// For SSH repositories the Secret must contain 'identity', 'identity.pub' // For SSH repositories the Secret must contain 'identity'
// and 'known_hosts' fields. // and 'known_hosts' fields.
// +optional // +optional
SecretRef *meta.LocalObjectReference `json:"secretRef,omitempty"` SecretRef *meta.LocalObjectReference `json:"secretRef,omitempty"`

View File

@ -149,8 +149,8 @@ spec:
secretRef: secretRef:
description: The secret name containing the Git credentials. For HTTPS description: The secret name containing the Git credentials. For HTTPS
repositories the secret must contain username and password fields. repositories the secret must contain username and password fields.
For SSH repositories the secret must contain identity, identity.pub For SSH repositories the secret must contain identity and known_hosts
and known_hosts fields. fields.
properties: properties:
name: name:
description: Name of the referent. description: Name of the referent.
@ -493,8 +493,7 @@ spec:
description: SecretRef specifies the Secret containing authentication description: SecretRef specifies the Secret containing authentication
credentials for the GitRepository. For HTTPS repositories the Secret credentials for the GitRepository. For HTTPS repositories the Secret
must contain 'username' and 'password' fields. For SSH repositories must contain 'username' and 'password' fields. For SSH repositories
the Secret must contain 'identity', 'identity.pub' and 'known_hosts' the Secret must contain 'identity' and 'known_hosts' fields.
fields.
properties: properties:
name: name:
description: Name of the referent. description: Name of the referent.

View File

@ -321,7 +321,7 @@ github.com/fluxcd/pkg/apis/meta.LocalObjectReference
the GitRepository. the GitRepository.
For HTTPS repositories the Secret must contain &lsquo;username&rsquo; and &lsquo;password&rsquo; For HTTPS repositories the Secret must contain &lsquo;username&rsquo; and &lsquo;password&rsquo;
fields. fields.
For SSH repositories the Secret must contain &lsquo;identity&rsquo;, &lsquo;identity.pub&rsquo; For SSH repositories the Secret must contain &lsquo;identity&rsquo;
and &lsquo;known_hosts&rsquo; fields.</p> and &lsquo;known_hosts&rsquo; fields.</p>
</td> </td>
</tr> </tr>
@ -1405,7 +1405,7 @@ github.com/fluxcd/pkg/apis/meta.LocalObjectReference
the GitRepository. the GitRepository.
For HTTPS repositories the Secret must contain &lsquo;username&rsquo; and &lsquo;password&rsquo; For HTTPS repositories the Secret must contain &lsquo;username&rsquo; and &lsquo;password&rsquo;
fields. fields.
For SSH repositories the Secret must contain &lsquo;identity&rsquo;, &lsquo;identity.pub&rsquo; For SSH repositories the Secret must contain &lsquo;identity&rsquo;
and &lsquo;known_hosts&rsquo; fields.</p> and &lsquo;known_hosts&rsquo; fields.</p>
</td> </td>
</tr> </tr>

View File

@ -152,9 +152,8 @@ data:
#### SSH authentication #### SSH authentication
To authenticate towards a Git repository over SSH, the referenced Secret is To authenticate towards a Git repository over SSH, the referenced Secret is
expected to contain `.data.identity`, `.data.identity.pub` and `known_hosts` expected to contain `.data.identity` and `known_hosts` fields. With the respective
fields. With the respective private and public key of the SSH key pair, and the private key of the SSH key pair, and the host keys of the Git repository.
host keys of the Git repository.
```yaml ```yaml
--- ---
@ -165,7 +164,6 @@ metadata:
type: Opaque type: Opaque
data: data:
identity: <BASE64> identity: <BASE64>
identity.pub: <BASE64>
known_hosts: <BASE64> known_hosts: <BASE64>
``` ```