Merge pull request #926 from fluxcd/status-observed-source-config

Add explicit observed artifact content configurations in status

api/v1beta2/bucket_types.go

@@ -128,6 +128,11 @@ type BucketStatus struct {
  // +optional
  Artifact *Artifact `json:"artifact,omitempty"`
 
+ // ObservedIgnore is the observed exclusion patterns used for constructing
+ // the source artifact.
+ // +optional
+ ObservedIgnore *string `json:"observedIgnore,omitempty"`
+
  meta.ReconcileRequestStatus `json:",inline"`
 }
 

api/v1beta2/gitrepository_types.go

@@ -224,9 +224,27 @@ type GitRepositoryStatus struct {
  // be used to determine if the content of the included repository has
  // changed.
  // It has the format of `<algo>:<checksum>`, for example: `sha256:<checksum>`.
+ //
+ // Deprecated: Replaced with explicit fields for observed artifact content
+ // config in the status.
  // +optional
  ContentConfigChecksum string `json:"contentConfigChecksum,omitempty"`
 
+ // ObservedIgnore is the observed exclusion patterns used for constructing
+ // the source artifact.
+ // +optional
+ ObservedIgnore *string `json:"observedIgnore,omitempty"`
+
+ // ObservedRecurseSubmodules is the observed resource submodules
+ // configuration used to produce the current Artifact.
+ // +optional
+ ObservedRecurseSubmodules bool `json:"observedRecurseSubmodules,omitempty"`
+
+ // ObservedInclude is the observed list of GitRepository resources used to
+ // to produce the current Artifact.
+ // +optional
+ ObservedInclude []GitRepositoryInclude `json:"observedInclude,omitempty"`
+
  meta.ReconcileRequestStatus `json:",inline"`
 }
 

api/v1beta2/ocirepository_types.go

@@ -211,9 +211,22 @@ type OCIRepositoryStatus struct {
  // be used to determine if the content configuration has changed and the
  // artifact needs to be rebuilt.
  // It has the format of `<algo>:<checksum>`, for example: `sha256:<checksum>`.
+ //
+ // Deprecated: Replaced with explicit fields for observed artifact content
+ // config in the status.
  // +optional
  ContentConfigChecksum string `json:"contentConfigChecksum,omitempty"`
 
+ // ObservedIgnore is the observed exclusion patterns used for constructing
+ // the source artifact.
+ // +optional
+ ObservedIgnore *string `json:"observedIgnore,omitempty"`
+
+ // ObservedLayerSelector is the observed layer selector used for constructing
+ // the source artifact.
+ // +optional
+ ObservedLayerSelector *OCILayerSelector `json:"observedLayerSelector,omitempty"`
+
  meta.ReconcileRequestStatus `json:",inline"`
 }
 

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

@@ -492,6 +492,10 @@ spec:
  the Bucket object.
  format: int64
  type: integer
+ observedIgnore:
+ description: ObservedIgnore is the observed exclusion patterns used
+ for constructing the source artifact.
+ type: string
  url:
  description: URL is the dynamic fetch link for the latest Artifact.
  It is provided on a "best effort" basis, and using the precise BucketStatus.Artifact

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

@@ -658,13 +658,14 @@ spec:
  type: object
  type: array
  contentConfigChecksum:
- description: 'ContentConfigChecksum is a checksum of all the configurations
+ description: "ContentConfigChecksum is a checksum of all the configurations
  related to the content of the source artifact: - .spec.ignore -
  .spec.recurseSubmodules - .spec.included and the checksum of the
  included artifacts observed in .status.observedGeneration version
  of the object. This can be used to determine if the content of the
  included repository has changed. It has the format of `<algo>:<checksum>`,
- for example: `sha256:<checksum>`.'
+ for example: `sha256:<checksum>`. \n Deprecated: Replaced with explicit
+ fields for observed artifact content config in the status."
  type: string
  includedArtifacts:
  description: IncludedArtifacts contains a list of the last successfully
@@ -723,6 +724,44 @@ spec:
  the GitRepository object.
  format: int64
  type: integer
+ observedIgnore:
+ description: ObservedIgnore is the observed exclusion patterns used
+ for constructing the source artifact.
+ type: string
+ observedInclude:
+ description: ObservedInclude is the observed list of GitRepository
+ resources used to to produce the current Artifact.
+ items:
+ description: GitRepositoryInclude specifies a local reference to
+ a GitRepository which Artifact (sub-)contents must be included,
+ and where they should be placed.
+ properties:
+ fromPath:
+ description: FromPath specifies the path to copy contents from,
+ defaults to the root of the Artifact.
+ type: string
+ repository:
+ description: GitRepositoryRef specifies the GitRepository which
+ Artifact contents must be included.
+ properties:
+ name:
+ description: Name of the referent.
+ type: string
+ required:
+ - name
+ type: object
+ toPath:
+ description: ToPath specifies the path to copy contents to,
+ defaults to the name of the GitRepositoryRef.
+ type: string
+ required:
+ - repository
+ type: object
+ type: array
+ observedRecurseSubmodules:
+ description: ObservedRecurseSubmodules is the observed resource submodules
+ configuration used to produce the current Artifact.
+ type: boolean
  url:
  description: URL is the dynamic fetch link for the latest Artifact.
  It is provided on a "best effort" basis, and using the precise GitRepositoryStatus.Artifact

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

@@ -301,12 +301,14 @@ spec:
  type: object
  type: array
  contentConfigChecksum:
- description: 'ContentConfigChecksum is a checksum of all the configurations
+ description: "ContentConfigChecksum is a checksum of all the configurations
  related to the content of the source artifact: - .spec.ignore -
  .spec.layerSelector observed in .status.observedGeneration version
  of the object. This can be used to determine if the content configuration
  has changed and the artifact needs to be rebuilt. It has the format
- of `<algo>:<checksum>`, for example: `sha256:<checksum>`.'
+ of `<algo>:<checksum>`, for example: `sha256:<checksum>`. \n Deprecated:
+ Replaced with explicit fields for observed artifact content config
+ in the status."
  type: string
  lastHandledReconcileAt:
  description: LastHandledReconcileAt holds the value of the most recent
@@ -317,6 +319,29 @@ spec:
  description: ObservedGeneration is the last observed generation.
  format: int64
  type: integer
+ observedIgnore:
+ description: ObservedIgnore is the observed exclusion patterns used
+ for constructing the source artifact.
+ type: string
+ observedLayerSelector:
+ description: ObservedLayerSelector is the observed layer selector
+ used for constructing the source artifact.
+ properties:
+ mediaType:
+ description: MediaType specifies the OCI media type of the layer
+ which should be extracted from the OCI Artifact. The first layer
+ matching this type is selected.
+ type: string
+ operation:
+ description: Operation specifies how the selected layer should
+ be processed. By default, the layer compressed content is extracted
+ to storage. When the operation is set to 'copy', the layer compressed
+ content is persisted to storage as it is.
+ enum:
+ - extract
+ - copy
+ type: string
+ type: object
  url:
  description: URL is the download link for the artifact output of the
  last OCI Repository sync.

controllers/bucket_controller.go

@@ -628,6 +628,7 @@ func (r *BucketReconciler) reconcileArtifact(ctx context.Context, obj *sourcev1.
 
  // Record it on the object
  obj.Status.Artifact = artifact.DeepCopy()
+ obj.Status.ObservedIgnore = obj.Spec.Ignore
 
  // Update symlink on a "best effort" basis
  url, err := r.Storage.Symlink(artifact, "latest.tar.gz")