@@ -5,7 +5,7 @@ repository.
5
5
6
6
## Example
7
7
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
9
9
(` .tar.gz ` ) Artifact with the fetched data from an OCI repository for the
10
10
resolved digest.
11
11
25
25
26
26
In the above example:
27
27
28
- - A OCIRepository named ` podinfo` is created, indicated by the
28
+ - An OCIRepository named ` podinfo` is created, indicated by the
29
29
` .metadata.name` field.
30
30
- The source-controller checks the OCI repository every five minutes, indicated
31
31
by the `.spec.interval` field.
@@ -87,19 +87,19 @@ You can run this example by saving the manifest into `ocirepository.yaml`.
87
87
88
88
# # Writing an OCIRepository spec
89
89
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
92
92
valid [DNS subdomain name](https://kubernetes.io/docs/concepts/overview/working-with-objects/names#dns-subdomain-names).
93
93
94
- A OCIRepository also needs a
94
+ An OCIRepository also needs a
95
95
[`.spec` section](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status).
96
96
97
97
# ## URL
98
98
99
99
` .spec.url` is a required field that specifies the address of the
100
100
container image repository in the format `oci://<host>:<port>/<org-name>/<repo-name>`.
101
101
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.
103
103
104
104
# ## Provider
105
105
@@ -119,13 +119,13 @@ static credentials are used for authentication, either with
119
119
If you do not specify `.spec.provider`, it defaults to `generic`.
120
120
121
121
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.
123
123
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
125
125
with an Azure AAD Pod Identity that grants read-only access to ACR.
126
126
127
127
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
129
129
read-only access to Artifact Registry.
130
130
131
131
# ## Secret reference
@@ -134,7 +134,7 @@ read-only access to Artifact Registry.
134
134
Secret in the same namespace as the OCIRepository, containing authentication
135
135
credentials for the OCI repository.
136
136
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].
138
138
The usual way to create such a secret is with :
139
139
140
140
` ` ` sh
@@ -315,7 +315,7 @@ spec:
315
315
# ## Triggering a reconcile
316
316
317
317
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
319
319
`reconcile.fluxcd.io/requestedAt : <arbitrary value>`. Annotating the resource
320
320
queues the OCIRepository for reconciliation if the `<arbitrary-value>` differs
321
321
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
345
345
# ## Suspending and resuming
346
346
347
347
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
349
349
[`.spec.suspend` field](#suspend).
350
350
351
351
# ### Suspend an OCIRepository
@@ -374,7 +374,7 @@ Using `flux`:
374
374
flux suspend source oci <repository-name>
375
375
` ` `
376
376
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
378
378
Artifact later disappears from the storage due to e.g. the source-controller
379
379
Pod being evicted from a Node, this will not be reflected in the
380
380
OCIRepository's Status until it is resumed.
@@ -519,7 +519,7 @@ To define your own exclusion rules, see [excluding files](#excluding-files).
519
519
520
520
# ## Conditions
521
521
522
- A OCIRepository enters various states during its lifecycle, reflected as
522
+ OCIRepository has various states during its lifecycle, reflected as
523
523
[Kubernetes Conditions][typical-status-properties].
524
524
It can be [reconciling](#reconciling-ocirepository) while fetching the remote
525
525
state, it can be [ready](#ready-ocirepository), or it can [fail during
@@ -532,7 +532,7 @@ become `Ready`.
532
532
533
533
# ### Reconciling OCIRepository
534
534
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
536
536
following is true :
537
537
538
538
- 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"`.
561
561
562
562
# ### Ready OCIRepository
563
563
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
565
565
following characteristics :
566
566
567
567
- The OCIRepository reports an [Artifact](#artifact).
0 commit comments