Skip to content

Commit b222d8b

Browse files
committed
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>
1 parent bc5a47e commit b222d8b

File tree

4 files changed

+10
-13
lines changed

4 files changed

+10
-13
lines changed

api/v1beta2/gitrepository_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ type GitRepositorySpec struct {
5656
// the GitRepository.
5757
// For HTTPS repositories the Secret must contain 'username' and 'password'
5858
// fields.
59-
// For SSH repositories the Secret must contain 'identity', 'identity.pub'
59+
// For SSH repositories the Secret must contain 'identity'
6060
// and 'known_hosts' fields.
6161
// +optional
6262
SecretRef *meta.LocalObjectReference `json:"secretRef,omitempty"`

config/crd/bases/source.toolkit.fluxcd.io_gitrepositories.yaml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,8 @@ spec:
149149
secretRef:
150150
description: The secret name containing the Git credentials. For HTTPS
151151
repositories the secret must contain username and password fields.
152-
For SSH repositories the secret must contain identity, identity.pub
153-
and known_hosts fields.
152+
For SSH repositories the secret must contain identity and known_hosts
153+
fields.
154154
properties:
155155
name:
156156
description: Name of the referent.
@@ -493,8 +493,7 @@ spec:
493493
description: SecretRef specifies the Secret containing authentication
494494
credentials for the GitRepository. For HTTPS repositories the Secret
495495
must contain 'username' and 'password' fields. For SSH repositories
496-
the Secret must contain 'identity', 'identity.pub' and 'known_hosts'
497-
fields.
496+
the Secret must contain 'identity' and 'known_hosts' fields.
498497
properties:
499498
name:
500499
description: Name of the referent.

docs/api/source.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ github.com/fluxcd/pkg/apis/meta.LocalObjectReference
321321
the GitRepository.
322322
For HTTPS repositories the Secret must contain &lsquo;username&rsquo; and &lsquo;password&rsquo;
323323
fields.
324-
For SSH repositories the Secret must contain &lsquo;identity&rsquo;, &lsquo;identity.pub&rsquo;
324+
For SSH repositories the Secret must contain &lsquo;identity&rsquo;
325325
and &lsquo;known_hosts&rsquo; fields.</p>
326326
</td>
327327
</tr>
@@ -1405,7 +1405,7 @@ github.com/fluxcd/pkg/apis/meta.LocalObjectReference
14051405
the GitRepository.
14061406
For HTTPS repositories the Secret must contain &lsquo;username&rsquo; and &lsquo;password&rsquo;
14071407
fields.
1408-
For SSH repositories the Secret must contain &lsquo;identity&rsquo;, &lsquo;identity.pub&rsquo;
1408+
For SSH repositories the Secret must contain &lsquo;identity&rsquo;
14091409
and &lsquo;known_hosts&rsquo; fields.</p>
14101410
</td>
14111411
</tr>
@@ -1630,8 +1630,8 @@ Artifact
16301630
<td>
16311631
<code>includedArtifacts</code><br>
16321632
<em>
1633-
<a href="#source.toolkit.fluxcd.io/v1beta2.*./api/v1beta2.Artifact">
1634-
[]*./api/v1beta2.Artifact
1633+
<a href="#source.toolkit.fluxcd.io/v1beta2.*github.com/fluxcd/source-controller/api/v1beta2.Artifact">
1634+
[]*github.com/fluxcd/source-controller/api/v1beta2.Artifact
16351635
</a>
16361636
</em>
16371637
</td>

docs/spec/v1beta2/gitrepositories.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,8 @@ data:
152152
#### SSH authentication
153153

154154
To authenticate towards a Git repository over SSH, the referenced Secret is
155-
expected to contain `.data.identity`, `.data.identity.pub` and `known_hosts`
156-
fields. With the respective private and public key of the SSH key pair, and the
157-
host keys of the Git repository.
155+
expected to contain `.data.identity` and `known_hosts` fields. With the respective
156+
private key of the SSH key pair, and the host keys of the Git repository.
158157

159158
```yaml
160159
---
@@ -165,7 +164,6 @@ metadata:
165164
type: Opaque
166165
data:
167166
identity: <BASE64>
168-
identity.pub: <BASE64>
169167
known_hosts: <BASE64>
170168
```
171169

0 commit comments

Comments
 (0)