Skip to content

Commit 1966411

Browse files
stefanprodanPaulo Gomes
andauthored
API docs improvements
Co-authored-by: Paulo Gomes <[email protected]> Signed-off-by: Stefan Prodan <[email protected]>
1 parent c52576c commit 1966411

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/spec/v1beta2/ocirepositories.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ repository.
55

66
## Example
77

8-
The following is an example of a OCIRepository. It creates a tarball
8+
The following is an example of an OCIRepository. It creates a tarball
99
(`.tar.gz`) Artifact with the fetched data from an OCI repository for the
1010
resolved digest.
1111

@@ -25,7 +25,7 @@ spec:
2525
2626
In the above example:
2727
28-
- A OCIRepository named `podinfo` is created, indicated by the
28+
- An OCIRepository named `podinfo` is created, indicated by the
2929
`.metadata.name` field.
3030
- The source-controller checks the OCI repository every five minutes, indicated
3131
by the `.spec.interval` field.
@@ -87,19 +87,19 @@ You can run this example by saving the manifest into `ocirepository.yaml`.
8787

8888
## Writing an OCIRepository spec
8989

90-
As with all other Kubernetes config, a OCIRepository needs `apiVersion`,
91-
`kind`, and `metadata` fields. The name of a OCIRepository object must be a
90+
As with all other Kubernetes config, an OCIRepository needs `apiVersion`,
91+
`kind`, and `metadata` fields. The name of an OCIRepository object must be a
9292
valid [DNS subdomain name](https://kubernetes.io/docs/concepts/overview/working-with-objects/names#dns-subdomain-names).
9393

94-
A OCIRepository also needs a
94+
An OCIRepository also needs a
9595
[`.spec` section](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status).
9696

9797
### URL
9898

9999
`.spec.url` is a required field that specifies the address of the
100100
container image repository in the format `oci://<host>:<port>/<org-name>/<repo-name>`.
101101

102-
**Note:** that specifying a tag or digest is not in accepted for this field.
102+
**Note:** that specifying a tag or digest is not acceptable for this field.
103103

104104
### Provider
105105

@@ -119,13 +119,13 @@ static credentials are used for authentication, either with
119119
If you do not specify `.spec.provider`, it defaults to `generic`.
120120

121121
The `aws` provider can be used when the source-controller service account
122-
is associate with an AWS IAM Role using IRSA that grants read-only access to ECR.
122+
is associated with an AWS IAM Role using IRSA that grants read-only access to ECR.
123123

124-
The `azure` provider can be used when the source-controller pods are associate
124+
The `azure` provider can be used when the source-controller pods are associated
125125
with an Azure AAD Pod Identity that grants read-only access to ACR.
126126

127127
The `gcp` provider can be used when the source-controller service account
128-
is associate with a GCP IAM Role using Workload Identity that grants
128+
is associated with a GCP IAM Role using Workload Identity that grants
129129
read-only access to Artifact Registry.
130130

131131
### Secret reference
@@ -134,7 +134,7 @@ read-only access to Artifact Registry.
134134
Secret in the same namespace as the OCIRepository, containing authentication
135135
credentials for the OCI repository.
136136

137-
This secret is expected to be in the same format as for[`imagePullSecrets`][image-pull-secrets].
137+
This secret is expected to be in the same format as [`imagePullSecrets`][image-pull-secrets].
138138
The usual way to create such a secret is with:
139139

140140
```sh
@@ -315,7 +315,7 @@ spec:
315315
### Triggering a reconcile
316316

317317
To manually tell the source-controller to reconcile a OCIRepository outside the
318-
[specified interval window](#interval), a OCIRepository can be annotated with
318+
[specified interval window](#interval), an OCIRepository can be annotated with
319319
`reconcile.fluxcd.io/requestedAt: <arbitrary value>`. Annotating the resource
320320
queues the OCIRepository for reconciliation if the `<arbitrary-value>` differs
321321
from the last value the controller acted on, as reported in
@@ -345,7 +345,7 @@ kubectl wait gitrepository/<repository-name> --for=condition=ready --timeout=1m
345345
### Suspending and resuming
346346

347347
When you find yourself in a situation where you temporarily want to pause the
348-
reconciliation of a OCIRepository, you can suspend it using the
348+
reconciliation of an OCIRepository, you can suspend it using the
349349
[`.spec.suspend` field](#suspend).
350350

351351
#### Suspend an OCIRepository
@@ -374,7 +374,7 @@ Using `flux`:
374374
flux suspend source oci <repository-name>
375375
```
376376

377-
**Note:** When a OCIRepository has an Artifact and is suspended, and this
377+
**Note:** When an OCIRepository has an Artifact and it is suspended, and this
378378
Artifact later disappears from the storage due to e.g. the source-controller
379379
Pod being evicted from a Node, this will not be reflected in the
380380
OCIRepository's Status until it is resumed.
@@ -519,7 +519,7 @@ To define your own exclusion rules, see [excluding files](#excluding-files).
519519

520520
### Conditions
521521

522-
A OCIRepository enters various states during its lifecycle, reflected as
522+
OCIRepository has various states during its lifecycle, reflected as
523523
[Kubernetes Conditions][typical-status-properties].
524524
It can be [reconciling](#reconciling-ocirepository) while fetching the remote
525525
state, it can be [ready](#ready-ocirepository), or it can [fail during
@@ -532,7 +532,7 @@ become `Ready`.
532532

533533
#### Reconciling OCIRepository
534534

535-
The source-controller marks a OCIRepository as _reconciling_ when one of the
535+
The source-controller marks an OCIRepository as _reconciling_ when one of the
536536
following is true:
537537

538538
- There is no current Artifact for the OCIRepository, or the reported Artifact
@@ -561,7 +561,7 @@ and are only present on the OCIRepository while their status value is `"True"`.
561561

562562
#### Ready OCIRepository
563563

564-
The source-controller marks a OCIRepository as _ready_ when it has the
564+
The source-controller marks an OCIRepository as _ready_ when it has the
565565
following characteristics:
566566

567567
- The OCIRepository reports an [Artifact](#artifact).

0 commit comments

Comments
 (0)