2025

open-component-model · Jan 8, 2025 · d502c73 · d502c73
1 parent d9af275
commit d502c73
Show file tree

Hide file tree

Showing 49 changed files with 146 additions and 201 deletions.
diff --git a/README.md b/README.md
@@ -95,6 +95,6 @@ AI-generated code or content can be contributed to SAP Open Source Software proj
 
 ## Licensing
 
-Copyright 2024 SAP SE or an SAP affiliate company and Open Component Model contributors.
+Copyright 2025 SAP SE or an SAP affiliate company and Open Component Model contributors.
 Please see our [LICENSE](LICENSE) for copyright and license information.
 Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/open-component-model/ocm-website).
diff --git a/REUSE.toml b/REUSE.toml
@@ -7,5 +7,5 @@ SPDX-PackageComment = "The code in this project may include calls to APIs (\"API
 [[annotations]]
 path = "**"
 precedence = "aggregate"
-SPDX-FileCopyrightText = "2024 SAP SE or an SAP affiliate company and Open Component Model contributors"
+SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and Open Component Model contributors"
 SPDX-License-Identifier = "Apache-2.0"
diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml
@@ -17,10 +17,10 @@ disableLanguages = ["de", "nl"]
 defaultContentLanguageInSubdir = false
 
 # Footer
-footer = '<small>© Copyright 2024, <a href="https://www.sap.com/corporate/en/legal/copyright.html">SAP SE </a> and Open Component Model Contributors | <a href="https://www.sap.com/about/legal/trademark.html">Trademark </a> | <a href="https://www.sap.com/about/legal/privacy.html">Privacy Policy</a> | <a href="https://www.sap.com/corporate/en/legal/terms-of-use.html">Terms of Use</a> | <a href="https://www.sap.com/corporate/en/legal/impressum.html">Legal Disclosure</a></small>'
+footer = '<small>© Copyright 2025, <a href="https://www.sap.com/corporate/en/legal/copyright.html">SAP SE </a> and Open Component Model Contributors | <a href="https://www.sap.com/about/legal/trademark.html">Trademark </a> | <a href="https://www.sap.com/about/legal/privacy.html">Privacy Policy</a> | <a href="https://www.sap.com/corporate/en/legal/terms-of-use.html">Terms of Use</a> | <a href="https://www.sap.com/corporate/en/legal/impressum.html">Legal Disclosure</a></small>'
 
 # Feed
-copyRight = "© Copyright 2024, SAP SE and Open Component Model Contributors"
+copyRight = "© Copyright 2025, SAP SE and Open Component Model Contributors"
 
 repoHost = "GitHub"
 docsRepo = "https://github.com/open-component-model/ocm-website"

diff --git a/config/_default/languages.toml b/config/_default/languages.toml
@@ -5,4 +5,4 @@
   [en.params]
     languageISO = "EN"
     languageTag = "en-US"
-    footer = '<small>© Copyright 2024, <a href="https://www.sap.com/corporate/en/legal/copyright.html">SAP SE </a> and Open Component Model Contributors | <a href="https://www.sap.com/about/legal/trademark.html">Trademark </a> | <a href="https://www.sap.com/about/legal/privacy.html">Privacy Policy</a> | <a href="https://www.sap.com/corporate/en/legal/terms-of-use.html">Terms of Use</a> | <a href="https://www.sap.com/corporate/en/legal/impressum.html">Legal Disclosure</a></small>'
+    footer = '<small>© Copyright 2025, <a href="https://www.sap.com/corporate/en/legal/copyright.html">SAP SE </a> and Open Component Model Contributors | <a href="https://www.sap.com/about/legal/trademark.html">Trademark </a> | <a href="https://www.sap.com/about/legal/privacy.html">Privacy Policy</a> | <a href="https://www.sap.com/corporate/en/legal/terms-of-use.html">Terms of Use</a> | <a href="https://www.sap.com/corporate/en/legal/impressum.html">Legal Disclosure</a></small>'
diff --git a/content/_index.md b/content/_index.md
@@ -2,8 +2,6 @@
 title : "Open Component Model"
 description: "The Open Component Model is an open standard to describe the software artifacts which must be delivered
 for a software product."
-date: 2020-10-06T08:47:36+00:00
-lastmod: 2020-10-06T08:47:36+00:00
 draft: false
 images: []
 sidebar:

diff --git a/content/docs/component-descriptors/_index.md b/content/docs/component-descriptors/_index.md
@@ -2,8 +2,6 @@
 title: "Component Descriptors"
 description: ""
 lead: ""
-date: 2023-01-17T10:22:05Z
-lastmod: 2023-01-17T10:22:05Z
 draft: false
 images: []
 weight: 50

diff --git a/content/docs/component-descriptors/version-2.md b/content/docs/component-descriptors/version-2.md
@@ -2,8 +2,6 @@
 title: "Version 2"
 description: ""
 lead: ""
-date: 2023-01-17T10:22:20Z
-lastmod: 2023-01-17T10:22:20Z
 draft: false
 images: []
 weight: 1
@@ -21,89 +19,89 @@ ocm componentversion get --repo ghcr.io/phoban01/ocm github.com/weaveworks/weave
 ```yaml
 meta:
   # component schema version
-  schemaVersion: v2 
+  schemaVersion: v2
 component:
   # name of the component. Must start with URL-prefix that should be controlled
   # by the owner of the component to avoid collisions
   # regex: ^[a-z][-a-z0-9]*([.][a-z][-a-z0-9]*)*[.][a-z]{2,}(/[a-z][-a-z0-9_]*([.][a-z][-a-z0-9_]*)*)+$
-  name: github.com/weaveworks/weave-gitops 
+  name: github.com/weaveworks/weave-gitops
   # version of the component. Must adhere to “relaxed SemVer”
   # major, minor (+ optional patch level) - optional v-prefix
   # regex: ^[v]?(0|[1-9]\\d*)(?:\\.(0|[1-9]\\d*))?(?:\\.(0|[1-9]\\d*))?(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$
 
-  version: v1.0.0 
+  version: v1.0.0
   # component provider
-  provider: weaveworks 
+  provider: weaveworks
   # list of labels that can contain arbitrary metadata in form of K/V pairs
   # labels can be added on component root, resource, source and reference level
   labels:
   - name: link-to-documentation
     value: https://github.com/weaveworks/weave-gitops
   # list of repository context the component version "lived" in,
   # with the current one at the top
-  repositoryContexts:  
+  repositoryContexts:
   - baseUrl: ghcr.io
     componentNameMapping: urlPath
     subPath: phoban01/ocm
     type: OCIRegistry
   # list of resources that describe the payload of the component
-  resources: 
+  resources:
     # resource name
   - name: image
     # resource location (external repository or internal to this repository)
-    relation: external 
+    relation: external
     # resource type
-    type: ociImage 
+    type: ociImage
     # resource version. Must also adhere to “relaxed SemVer” (see `component.versio` above`)
     version: v0.14.1
     # metadata describing how to access the resource
     access:
       # type of access information
-      type: ociArtifact 
+      type: ociArtifact
       imageReference: ghcr.io/weaveworks/wego-app:v0.14.1
     # signing metadata for the resource (if component has been signed)
-    digest: 
+    digest:
       hashAlgorithm: SHA-256
       normalisationAlgorithm: ociArtifactDigest/v1
       value: efa2b9980ca2de65dc5a0c8cc05638b1a4b4ce8f6972dc08d0e805e5563ba5bb
   # list of sources that describe the input for creating the resources
-  sources: 
+  sources:
     # source name
   - name: weave-gitops
     # source type
-    type: git 
+    type: git
     # source version. Must also adhere to “relaxed SemVer” (see `component.versio` above`)
-    version: v0.14.1 
+    version: v0.14.1
     # metadata describing how to access the source
-    access: 
+    access:
       commit: 727513969553bfcc603e1c0ae1a75d79e4132b58
       ref: refs/tags/v0.14.1
       repoUrl: github.com/weaveworks/weave-gitops
       type: gitHub
   # list of references to other components
   componentReferences:
-  # reference name 
-  - name: prometheus 
+  # reference name
+  - name: prometheus
     # reference version
-    version: v1.0.0 
+    version: v1.0.0
     # referenced component name
-    componentName: cncf.io/prometheus 
+    componentName: cncf.io/prometheus
     # signing metadata for the referenced resource (if component has been signed)
-    digest: 
+    digest:
       hashAlgorithm: SHA-256
       normalisationAlgorithm: jsonNormalisation/v1
       value: 04eb20b6fd942860325caf7f4415d1acf287a1aabd9e4827719328ba25d6f801
 # list of signatures used for signing and verification
-signatures: 
+signatures:
   # name of the signature
-- name: ww-dev 
+- name: ww-dev
   # digest of the signature including the algorithm used
-  digest: 
+  digest:
     hashAlgorithm: SHA-256
     normalisationAlgorithm: jsonNormalisation/v1
     value: 4faff7822616305ecd09284d7c3e74a64f2269dcc524a9cdf0db4b592b8cee6a
   # signature including the algorithm used
-  signature: 
+  signature:
     algorithm: RSASSA-PSS
     mediaType: application/vnd.ocm.signature.rsa
     value: 26468587671bdbd2166cf5f69829f090c10768511b15e804294fcb26e552654316c8f4851ed396f279ec99335e5f4b11cb043feb97f1f9a42115f4fda2d31ae8b481b7303b9a913d3a4b92d446fbee9ed487c93b09e513f3f68355040ec08454675e1f407422062abbd2681f70dd5488ad29020b30cfa7e001455c550458da96166bc3243c8426977d73352aface5323fb2b5a374e9c31b272a59c160b85631231c9fc2f23c032401b80fef937029a39111cee34470c61ae86cd4942553466411a5a116159fdcc10e50fe9360c5184028e72d1fe9c7315f26e15d7b4849f62d197501b8cc6b6f1b1391ecc2fc2fc0c1290d2554594505b25fa8f9bfb28c8df24

diff --git a/content/docs/contribution/_index.md b/content/docs/contribution/_index.md
@@ -3,11 +3,8 @@ title : "Contribute"
 description: "Contribute to OCM."
 weight: 100
 lead: ""
-date: 2020-10-06T08:48:23+00:00
-lastmod: 2020-10-06T08:48:23+00:00
 draft: false
 images: []
 sidebar:
   collapsed: true
 ---
-
diff --git a/content/docs/contribution/contributing.md b/content/docs/contribution/contributing.md
@@ -77,23 +77,23 @@ Ready to contribute? Read and follow the sections below to get your contribution
 
 ### Licensing and Copyright information on file level
 
-In general all files of the project are created under Apache 2.0 license. The project uses the [REUSE process and tooling](https://reuse.software) that supports maintaining licensing information centrally in a `.reuse/dep5 config` file on repository level. This means that in general there SHOULD NOT be any license and copyright specifiy SPDX headers on file level. Only in cases where content is copied from sources that use a different license and already use headers like
+In general all files of the project are created under Apache 2.0 license. The project uses the [REUSE process and tooling](https://reuse.software) that supports maintaining licensing information centrally in a `REUSE.toml` configuration file on repository level. This means that in general there SHOULD NOT be any license and copyright specify SPDX headers on file level. Only in cases where content is copied from sources that use a different license and already use headers like
 
-```
+```go
 // SPDX-FileCopyrightText: Copyright 2010 The Go Authors. All rights reserved.
 //
 // SPDX-License-Identifier: BSD-3-Clause
 ```
 
 the headers of the source file should be kept and eventually aggregated with the Apache 2.0 license. Please check the [REUSE FAQ](https://reuse.software/faq/#multi-licensing) for details.
 
-Such files should be explicitly added as deviating from the `.reuse/dep5` config file using the `Files-Excluded` field. Excluding the file `/pkg/foo.go` and `pkg/bar.go` from the general rule to add the Apache 2.0 license to all files, would look like this:
+Such files should be explicitly added as deviating from the `REUSE.toml` configuration file using the `Files-Excluded` field. Excluding the file `/pkg/foo.go` and `pkg/bar.go` from the general rule to add the Apache 2.0 license to all files, would look like this:
 
 ```bash
 Files: **
-Copyright: 2022 SAP SE or an SAP affiliate company and Open Component Model contributors
+Copyright: 2025 SAP SE or an SAP affiliate company and Open Component Model contributors
 License: Apache-2.0
-Files-Excluded: /pkg/foo.go pkg/bar.go 
+Files-Excluded: /pkg/foo.go pkg/bar.go
 ```
 
 ### Pull Request Checklist

diff --git a/content/docs/contribution/security.md b/content/docs/contribution/security.md
@@ -2,8 +2,6 @@
 title: "Security Guideline"
 description: "Security Guideline"
 lead: ""
-date: 2022-08-12T10:38:22+01:00
-lastmod: 2022-08-12T10:38:22+01:00
 draft: false
 images: []
 weight: 102

diff --git a/content/docs/controller/_index.md b/content/docs/controller/_index.md
@@ -3,12 +3,9 @@ title : "OCM Controllers"
 description: ""
 weight: 40
 lead: ""
-date: 2020-10-06T08:48:23+00:00
-lastmod: 2020-10-06T08:48:23+00:00
 draft: false
 images: []
 weight: 40
 sidebar:
   collapsed: true
 ---
-
diff --git a/content/docs/controller/controller-reference/_index.md b/content/docs/controller/controller-reference/_index.md
@@ -2,8 +2,6 @@
 title: "Kubernetes Controllers"
 description: ""
 lead: ""
-date: 2022-01-25T14:40:56+01:00
-lastmod: 2022-01-25T14:40:56+01:00
 draft: false
 images: []
 weight: 50

diff --git a/content/docs/controller/controller-reference/api-reference/_index.md b/content/docs/controller/controller-reference/api-reference/_index.md
@@ -2,8 +2,6 @@
 title: "API Reference"
 description: ""
 lead: ""
-date: 2022-01-25T14:40:56+01:00
-lastmod: 2022-01-25T14:40:56+01:00
 draft: false
 images: []
 type: docs

diff --git a/content/docs/controller/controller-reference/api-reference/ocm-controller.md b/content/docs/controller/controller-reference/api-reference/ocm-controller.md
@@ -2,8 +2,6 @@
 title: "OCM Controller API v1"
 description: ""
 lead: ""
-date: 2023-06-27T13:54:59+01:00
-lastmod: 2024-03-12T11:20:59+01:00
 draft: false
 images: []
 weight: 52

diff --git a/...nt/docs/controller/controller-reference/api-reference/replication-controller.md b/...nt/docs/controller/controller-reference/api-reference/replication-controller.md
@@ -2,8 +2,6 @@
 title: "Replication Controller API v1"
 description: ""
 lead: ""
-date: 2023-07-10T11:34:56+01:00
-lastmod: 2023-07-10T11:34:56+01:00
 draft: false
 images: []
 weight: 53

diff --git a/content/docs/controller/controller-reference/ocm-controller/_index.md b/content/docs/controller/controller-reference/ocm-controller/_index.md
@@ -2,8 +2,6 @@
 title: "OCM Controller"
 description: ""
 lead: ""
-date: 2022-01-25T14:40:56+01:00
-lastmod: 2022-01-25T14:40:56+01:00
 draft: false
 images: []
 type: docs

diff --git a/content/docs/controller/controller-reference/ocm-controller/component-version.md b/content/docs/controller/controller-reference/ocm-controller/component-version.md
@@ -2,8 +2,6 @@
 title: "Component Version"
 description: ""
 lead: ""
-date: 2023-06-28T09:30:27+01:00
-lastmod: 2023-06-28T09:30:27+01:00
 draft: false
 images: []
 weight: 55

diff --git a/content/docs/controller/controller-reference/replication-controller/_index.md b/content/docs/controller/controller-reference/replication-controller/_index.md
@@ -2,8 +2,6 @@
 title: "Replication Controller"
 description: ""
 lead: ""
-date: 2022-01-25T14:40:56+01:00
-lastmod: 2022-01-25T14:40:56+01:00
 draft: false
 images: []
 type: docs

diff --git a/...ontroller/controller-reference/replication-controller/component-subscription.md b/...ontroller/controller-reference/replication-controller/component-subscription.md
@@ -2,8 +2,6 @@
 title: "Component Subscription"
 description: ""
 lead: ""
-date: 2023-07-11T16:07:00+01:00
-lastmod: 2023-07-11T16:07:00+01:00
 draft: false
 images: []
 weight: 57

diff --git a/content/docs/controller/installation.md b/content/docs/controller/installation.md
@@ -1,8 +1,6 @@
 ---
 title: "Installation"
 description: "OCM Controller Installation"
-date: 2023-06-27T16:16:48+01:00
-lastmod: 2023-06-27T16:16:48+01:00
 draft: false
 images: []
 weight: 42

diff --git a/content/docs/controller/overview.md b/content/docs/controller/overview.md
@@ -1,8 +1,6 @@
 ---
 title: "Architecture"
 description: "OCM Controller Architecture"
-date: 2023-10-20T11:24:41+01:00
-lastmod: 2023-10-20T11:24:41+01:00
 draft: false
 images: []
 weight: 41
@@ -36,12 +34,16 @@ The `ocm-controller` is responsible for the core work necessary to utilise resou
 Snapshots are used to pass resources between controllers and are stored in an in-cluster registry.
 
 The `ocm-controller` consists of 5 sub-controllers:
-- [Component Version Controller](#component-version-controller)
-- [Resource Controller](#resource-controller)
-- [Snapshot Controller](#snapshot-controller)
-- [Localization Controller](#localization-controller)
-- [Configuration Controller](#configuration-controller)
-- [FluxDeployer Controller](#fluxdeployer-controller)
+- [Controllers](#controllers)
+  - [OCM controller](#ocm-controller)
+    - [Component Version Controller](#component-version-controller)
+    - [Resource Controller](#resource-controller)
+    - [Snapshot Controller](#snapshot-controller)
+    - [Localization Controller](#localization-controller)
+    - [Configuration Controller](#configuration-controller)
+  - [FluxDeployer controller](#fluxdeployer-controller)
+  - [Replication controller](#replication-controller)
+- [In-cluster Docker Registry](#in-cluster-docker-registry)
 
 #### Component Version Controller
 
@@ -51,7 +53,7 @@ The Component Version controller reconciles component versions from an OCI repos
 sequenceDiagram
     User->>Kubernetes API: submit ComponentVersion CR
     Kubernetes API-->>Component Version Controller: Component Version Created Event
-    Component Version Controller->>OCM Repository: Find latest component matching semver 
+    Component Version Controller->>OCM Repository: Find latest component matching semver
     Component Version Controller->>OCM Repository: Validate signatures
     Component Version Controller->>OCM Repository: Download Component Descriptor
     Component Version Controller->>Kubernetes API: Submit Component Descriptor CR
@@ -299,7 +301,7 @@ sequenceDiagram
     User->>Kubernetes API: submit Component Subscription CR
     Kubernetes API-->>Replication Controller: Component Subscription Created Event
     Replication Controller->>Replication Controller: Determine new component is available in source repository based on semver
-    Replication Controller->>Source OCM Repository: Verify signatures 
+    Replication Controller->>Source OCM Repository: Verify signatures
     Source OCM Repository->>Destination OCM Repository: Transfer component by value
     Replication Controller->>Kubernetes API: Update Component Subscription status
 ```

diff --git a/content/docs/examples/_index.md b/content/docs/examples/_index.md
@@ -2,8 +2,6 @@
 title: "Examples"
 description: ""
 lead: ""
-date: 2023-11-07T11:45:27Z
-lastmod: 2023-11-07T11:45:27Z
 draft: false
 weight: 70
 images: []

diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md
@@ -2,8 +2,7 @@
 title: "Credentials in an .ocmconfig file"
 description: ""
 summary: ""
-date: 2024-09-04T13:54:01+02:00
-lastmod: 2024-09-04T13:54:01+02:00
+
 draft: false
 weight: 999
 toc: true