From a79ca2a60afaf39e5f6ea98252dc352fefaea6d2 Mon Sep 17 00:00:00 2001 From: Leo Christy Jesuraj Date: Fri, 24 Mar 2023 10:59:28 -0400 Subject: [PATCH] Update draft doc to v1 --- internal/doc/draft-user-guide-v1.adoc | 64 +++++++++++++-------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/internal/doc/draft-user-guide-v1.adoc b/internal/doc/draft-user-guide-v1.adoc index 233acb9a0..ef2d7657e 100755 --- a/internal/doc/draft-user-guide-v1.adoc +++ b/internal/doc/draft-user-guide-v1.adoc @@ -26,7 +26,7 @@ Each instance of `RuntimeComponent` CR represents the application to be deployed [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -126,7 +126,7 @@ To deploy a Docker image that contains a runtime component to a Kubernetes envir [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -153,7 +153,7 @@ To deploy an image from an image stream, use the following CR: [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -203,7 +203,7 @@ your CR as key/value pairs. [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -227,7 +227,7 @@ To add new annotations into all resources created for a `RuntimeComponent`, spec [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -256,7 +256,7 @@ override any environment variables specified in the container image. [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -311,7 +311,7 @@ The primary port is specified using `.spec.service.port` field and the additiona [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -367,7 +367,7 @@ The security context parameters are customizable under `.spec.securityContext` f [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -396,7 +396,7 @@ You can choose to create StatefulSet resources without storage, if you only requ [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -413,7 +413,7 @@ The operator will also create a volume mount for the `StatefulSet` mounting to ` [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -433,7 +433,7 @@ It is also possible to create multiple volume mount points for persistent volume [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -495,7 +495,7 @@ At minimum, a label needs to be provided that Prometheus expects to be set on `S [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -512,7 +512,7 @@ For advanced scenarios, it is possible to set many `ServicerMonitor` settings su [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -542,7 +542,7 @@ To create Knative service, set `createKnativeService` to `true`: [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -578,7 +578,7 @@ the startup, liveness, and readiness probes, the following configuration can be [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -620,7 +620,7 @@ of the liveness probe, you can use this config: [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -636,7 +636,7 @@ instead of using the default probe, e.g., [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -657,7 +657,7 @@ To expose your application externally, set `expose` to `true`: [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -683,7 +683,7 @@ To use the Ingress resource, set the `defaultHostName` variable in the _runtime- [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -702,7 +702,7 @@ Generate your certificate and specify the secret containing the certificate usin [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -722,7 +722,7 @@ You can provide an existing TLS secret and set a custom hostname. [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -755,7 +755,7 @@ To expose your application as a Knative service externally, set `expose` to `tru [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -776,7 +776,7 @@ policies for an application, set `.spec.networkPolicy.disable` to `true`: [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -814,7 +814,7 @@ Example of allowing incoming traffic from pods labeled with `role: frontend` and [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -828,7 +828,7 @@ Example of allowing incoming traffic from pods belonging to the same application [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -842,7 +842,7 @@ Example of allowing incoming traffic from pods labeled with `role: frontend` in [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -894,7 +894,7 @@ OpenShift service CA an annotation can be added to application's YAML: [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -916,7 +916,7 @@ Example of certificates specified for the Route: [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -965,7 +965,7 @@ Use `nodeAffinityLabels` field to set required labels for pod scheduling on spec [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -984,7 +984,7 @@ The following example requires a node type of _Large_ and preferences for two zo [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: my-app @@ -1025,7 +1025,7 @@ The following example shows that pod affinity is required and that the pods for [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeComponent metadata: name: Service-B @@ -1073,7 +1073,7 @@ Example: [source,yaml] ---- -apiVersion: rc.app.stacks/v1beta2 +apiVersion: rc.app.stacks/v1 kind: RuntimeOperation metadata: name: example-runtime-operation