https://sap.github.io/component-operator/docs/reference/Recent content in Reference on Component OperatorHugoen-ushttps://sap.github.io/component-operator/docs/reference/component/Mon, 01 Jan 0001 00:00:00 +0000https://sap.github.io/component-operator/docs/reference/component/<h2 id="overview">Overview</h2> <p>The <code>Component</code> custom resource is the primary API for managing Kubernetes components with component-operator. It defines a set of Kubernetes resources (deployments, services, RBAC, etc.) that are managed as a cohesive unit.</p> <h2 id="api-version">API Version</h2> <p><code>core.cs.sap.com/v1alpha1</code></p> <h2 id="kind">Kind</h2> <p><code>Component</code></p> <h2 id="spec">Spec</h2> <p>The <code>ComponentSpec</code> defines the desired state of a Component.</p> <h3 id="source-reference">Source Reference</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>sourceRef</code></td> <td><a href="#sourcereference">SourceReference</a></td> <td>Yes</td> <td>Reference to the source containing the manifest templates</td> </tr> <tr> <td><code>revision</code></td> <td>string</td> <td>No</td> <td>Pin component to a specific source revision</td> </tr> <tr> <td><code>digest</code></td> <td>string</td> <td>No</td> <td>Pin component to a specific source digest</td> </tr> <tr> <td><code>path</code></td> <td>string</td> <td>No</td> <td>Subfolder within the source (default: root)</td> </tr> </tbody> </table> <h3 id="placement-and-targeting">Placement and Targeting</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>namespace</code></td> <td>string</td> <td>No</td> <td>Target namespace for deployment (default: component&rsquo;s namespace)</td> </tr> <tr> <td><code>name</code></td> <td>string</td> <td>No</td> <td>Target name for deployment (default: component&rsquo;s name)</td> </tr> <tr> <td><code>serviceAccountName</code></td> <td>string</td> <td>No</td> <td>Service account to impersonate during reconciliation</td> </tr> <tr> <td><code>kubeConfig</code></td> <td><a href="#kubeconfigspec">KubeConfigSpec</a></td> <td>No</td> <td>KubeConfig for deploying to remote cluster</td> </tr> </tbody> </table> <h3 id="templating-and-values">Templating and Values</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>values</code></td> <td>JSON</td> <td>No</td> <td>Inline values for templating</td> </tr> <tr> <td><code>valuesFrom</code></td> <td>[]<a href="#secretkeyreference">SecretKeyReference</a></td> <td>No</td> <td>Secret references containing values</td> </tr> <tr> <td><code>decryption</code></td> <td><a href="#decryption">Decryption</a></td> <td>No</td> <td>Decryption settings for encrypted manifests</td> </tr> <tr> <td><code>postBuild</code></td> <td><a href="#postbuild">PostBuild</a></td> <td>No</td> <td>Post-build variable substitution and patches</td> </tr> </tbody> </table> <h3 id="reconciliation-control">Reconciliation Control</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>suspend</code></td> <td>boolean</td> <td>No</td> <td>Suspend reconciliation (default: false)</td> </tr> <tr> <td><code>requeueInterval</code></td> <td>duration</td> <td>No</td> <td>Period for re-reconciliation after success (default: 10m)</td> </tr> <tr> <td><code>retryInterval</code></td> <td>duration</td> <td>No</td> <td>Period for re-reconciliation after retriable error</td> </tr> <tr> <td><code>timeout</code></td> <td>duration</td> <td>No</td> <td>How long dependent objects have to become ready</td> </tr> <tr> <td><code>sticky</code></td> <td>boolean</td> <td>No</td> <td>Stick to source revision until ready or timeout</td> </tr> <tr> <td><code>reapplyInterval</code></td> <td>duration</td> <td>No</td> <td>Force reapply interval (default: 60m)</td> </tr> </tbody> </table> <h3 id="policies">Policies</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>adoptionPolicy</code></td> <td>string</td> <td>No</td> <td>How to handle existing objects (<code>IfUnowned</code>, <code>Never</code>, <code>Always</code>; default: <code>IfUnowned</code>)</td> </tr> <tr> <td><code>updatePolicy</code></td> <td>string</td> <td>No</td> <td>How to update objects (<code>Replace</code>, <code>Recreate</code>, <code>SsaMerge</code>, <code>SsaOverride</code>; default: <code>SsaOverride</code>)</td> </tr> <tr> <td><code>deletePolicy</code></td> <td>string</td> <td>No</td> <td>What happens on deletion (<code>Delete</code>, <code>Orphan</code>; default: <code>Delete</code>)</td> </tr> <tr> <td><code>missingNamespacesPolicy</code></td> <td>string</td> <td>No</td> <td>Auto-create missing namespaces (<code>Create</code>, <code>DoNotCreate</code>; default: <code>Create</code>)</td> </tr> </tbody> </table> <h3 id="advanced-configuration">Advanced Configuration</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>dependencies</code></td> <td>[]<a href="#dependency">Dependency</a></td> <td>No</td> <td>Dependencies to other components</td> </tr> <tr> <td><code>additionalManagedTypes</code></td> <td>[]<a href="#typeinfo">TypeInfo</a></td> <td>No</td> <td>Additional CRD types managed by this component</td> </tr> </tbody> </table> <h2 id="sourcereference">SourceReference</h2> <p>Defines the source of manifest templates. Exactly one source type must be provided.</p>https://sap.github.io/component-operator/docs/reference/blueprint/Mon, 01 Jan 0001 00:00:00 +0000https://sap.github.io/component-operator/docs/reference/blueprint/<h2 id="overview">Overview</h2> <p>The <code>Blueprint</code> custom resource provides an in-cluster mechanism for storing manifest templates. Blueprints serve as reusable component templates that can be referenced by Component resources, eliminating the need for external source repositories.</p> <h2 id="api-version">API Version</h2> <p><code>core.cs.sap.com/v1alpha1</code></p> <h2 id="kind">Kind</h2> <p><code>Blueprint</code></p> <h2 id="spec">Spec</h2> <p>The <code>BlueprintSpec</code> defines the desired state of a Blueprint.</p> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>files</code></td> <td>map[string]string</td> <td>No</td> <td>Map of file paths to file contents</td> </tr> </tbody> </table> <h3 id="files-field">Files Field</h3> <p>The <code>files</code> field contains a map where:</p>