Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -156,4 +156,7 @@
:3no-caps: Three-node OpenShift


:ocp-product-title: OpenShift Container Platform
:ocp-product-title: OpenShift Container Platform
:dedicated-product-title: OpenShift Dedicated
:aro-product-title: Azure Red Hat OpenShift
:rosa-product-title: Red Hat OpenShift Service on AWS
15 changes: 7 additions & 8 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Topics:
File: installing-knative-serving
- Name: Installing Knative Eventing
File: installing-knative-eventing
- Name: Configuring Knative Kafka
- Name: Configuring Knative for Apache Kafka
File: serverless-kafka-admin
- Name: Configuring Serverless Functions
File: configuring-serverless-functions
Expand Down Expand Up @@ -165,7 +165,7 @@ Topics:
File: serverless-apiserversource
- Name: Creating a ping source
File: serverless-pingsource
- Name: Kafka source
- Name: Source for Apache Kafka
File: serverless-kafka-developer-source
- Name: Custom event sources
File: serverless-custom-event-sources
Expand All @@ -176,7 +176,9 @@ Topics:
Topics:
- Name: Event sinks overview
File: serverless-event-sinks
- Name: Kafka sink
- Name: Creating event sinks
File: serverless-creating-sinks
- Name: Sink for Apache Kafka
File: serverless-kafka-developer-sink
- Name: Brokers
Dir: brokers
Expand All @@ -191,7 +193,7 @@ Topics:
File: serverless-broker-backing-channel-default
- Name: Configuring the default broker class
File: serverless-global-config-broker-class-default
- Name: Kafka broker
- Name: Knative broker for Apache Kafka
File: kafka-broker
- Name: Managing brokers
File: serverless-using-brokers-managing-brokers
Expand Down Expand Up @@ -227,7 +229,7 @@ Topics:
File: connecting-channels-sinks
- Name: Default channel implementation
File: serverless-channel-default
- Name: Security configuration for Knative Kafka channels
- Name: Security configuration for channels
File: serverless-kafka-admin-security-channels
- Name: Subscriptions
Dir: subscriptions
Expand Down Expand Up @@ -367,11 +369,8 @@ Topics:
File: serverless-tracing
- Name: Using Red Hat OpenShift distributed tracing
File: serverless-tracing-open-telemetry
Distros: openshift-enterprise
- Name: Using Jaeger distributed tracing
File: serverless-tracing-jaeger


---
# Integrations
Name: Integrations
Expand Down
4 changes: 2 additions & 2 deletions about/about-serverless.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ For additional information about the {ServerlessProductName} life cycle and supp
[role="_additional-resources"]
== Additional resources

* link:https://docs.openshift.com/container-platform/latest/operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-extending-api-with-crds[Extending the Kubernetes API with custom resource definitions]
* link:https://docs.openshift.com/container-platform/latest/operators/understanding/crds/crd-managing-resources-from-crds.adoc#crd-managing-resources-from-crds[Managing resources from custom resource definitions]
* link:https://docs.openshift.com/container-platform/latest/operators/understanding/crds/crd-extending-api-with-crds.html#crd-extending-api-with-crds[Extending the Kubernetes API with custom resource definitions]
* link:https://docs.openshift.com/container-platform/latest/operators/understanding/crds/crd-managing-resources-from-crds.html#crd-managing-resources-from-crds[Managing resources from custom resource definitions]
* link:https://www.redhat.com/en/topics/cloud-native-apps/what-is-serverless[What is serverless?]
19 changes: 6 additions & 13 deletions about/serverless-release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,30 +43,23 @@ include::modules/serverless-rn-1-26-0.adoc[leveloffset=+1]
// OCP + OSD + ROSA
include::modules/serverless-rn-1-25-0.adoc[leveloffset=+1]
// 1.25.0 additional resources, OCP docs
ifdef::openshift-enterprise[]

[role="_additional-resources"]
.Additional resources
* xref:../serverless/knative-serving/config-applications/serverless-config-tls.adoc#serverless-config-tls[Configuring TLS authentication]
endif::[]
.Additional resources for {ocp-product-title}
* xref:../knative-serving/config-applications/serverless-config-tls.adoc#serverless-config-tls[Configuring TLS authentication]

include::modules/serverless-rn-1-24-0.adoc[leveloffset=+1]
include::modules/serverless-rn-1-23-0.adoc[leveloffset=+1]

// 1.23.0 additional resources, OCP docs
ifdef::openshift-enterprise[]

[role="_additional-resources"]
.Additional resources
* link:https://docs.openshift.com/container-platform/latest/openshift_images/using_images/using-s21-images.adoc#using-s21-images[Source-to-Image]
endif::[]
.Additional resources for {ocp-product-title}
* link:https://docs.openshift.com/container-platform/latest/openshift_images/using_images/using-s21-images.html#using-s21-images[Source-to-Image]

// OSD + OCP
ifdef::openshift-enterprise,openshift-dedicated[]
include::modules/serverless-rn-1-22-0.adoc[leveloffset=+1]
include::modules/serverless-rn-1-21-0.adoc[leveloffset=+1]
include::modules/serverless-rn-1-20-0.adoc[leveloffset=+1]
endif::[]

ifdef::openshift-enterprise[]
include::modules/serverless-rn-1-19-0.adoc[leveloffset=+1]
include::modules/serverless-rn-1-18-0.adoc[leveloffset=+1]
endif::[]
9 changes: 7 additions & 2 deletions about/serverless-support.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,18 @@ If you have a suggestion for improving this guide or have found an error, you ca
// TODO: Update once https://issues.redhat.com/browse/OSDOCS-3730 is done to update this to Jira

// Generic help topics
ifdef::openshift-enterprise,openshift-dedicated[]
[NOTE]
====
The following section on defining cluster size requirements applies to these distributions:

* {ocp-product-title}
* {dedicated-product-title}
====

include::modules/support-knowledgebase-about.adoc[leveloffset=+1]
include::modules/support-knowledgebase-search.adoc[leveloffset=+1]
include::modules/support-submitting-a-case.adoc[leveloffset=+1]

endif::openshift-enterprise,openshift-dedicated[]

[id="serverless-support-gather-info"]
== Gathering diagnostic information for support
Expand Down
10 changes: 5 additions & 5 deletions functions/serverless-functions-getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ include::modules/serverless-deploy-func-kn.adoc[leveloffset=+1]
include::modules/serverless-kn-func-invoke.adoc[leveloffset=+1]
include::modules/serverless-kn-func-delete.adoc[leveloffset=+1]

ifdef::openshift-enterprise[]

[id="additional-resources_serverless-functions-getting-started"]
[role="_additional-resources"]
== Additional resources
* link:https://docs.openshift.com/container-platform/latest/registry/securing-exposing-registry.adoc#securing-exposing-registry[Exposing a default registry manually]
== Additional resources for {ocp-product-title}
* link:https://docs.openshift.com/container-platform/latest/registry/securing-exposing-registry.html#securing-exposing-registry[Exposing a default registry manually]
* link:https://plugins.jetbrains.com/plugin/16476-knative\--serverless-functions-by-red-hat[Marketplace page for the Intellij Knative plugin]
* link:https://marketplace.visualstudio.com/items?itemName=redhat.vscode-knative&utm_source=VSCode.pro&utm_campaign=AhmadAwais[Marketplace page for the Visual Studio Code Knative plugin]
* link:https://docs.openshift.com/container-platform/latest/applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-the-developer-perspective[Creating applications using the Developer perspective]
* link:https://docs.openshift.com/container-platform/latest/applications/creating_applications/odc-creating-applications-using-developer-perspective.html#odc-creating-applications-using-the-developer-perspective[Creating applications using the Developer perspective]
// This Additional resource applies only to OCP, but not to OSD nor ROSA.
endif::[]


[id="next-steps_serverless-functions-getting-started"]
== Next steps
Expand Down
37 changes: 7 additions & 30 deletions functions/serverless-functions-setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,49 +20,26 @@ To enable the use of {FunctionsProductName} on your cluster, you must complete t
Functions are deployed as a Knative service. If you want to use event-driven architecture with your functions, you must also install Knative Eventing.
====

ifdef::openshift-enterprise[]
* You have the link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[`oc` CLI] installed.
endif::[]
// need to wait til CLI docs are added to OSD and ROSA for this link to work
// TODO: remove these conditionals once this is available
ifdef::openshift-dedicated,openshift-rosa[]
* You have the `oc` CLI installed.
endif::[]

* You have the link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html#cli-getting-started[`oc` CLI] installed.

* You have the xref:../install/installing-kn.adoc#installing-kn[Knative (`kn`) CLI] installed. Installing the Knative CLI enables the use of `kn func` commands which you can use to create and manage functions.

* You have installed Docker Container Engine or Podman version 3.4.7 or higher.

* You have access to an available image registry, such as the OpenShift Container Registry.

ifdef::openshift-enterprise[]
* If you are using link:https://quay.io/[Quay.io] as the image registry, you must ensure that either the repository is not private, or that you have followed the {ocp-product-title} documentation on link:https://docs.openshift.com/container-platform/latest/openshift_images/managing_images/using-image-pull-secrets.adoc#images-allow-pods-to-reference-images-from-secure-registries_using-image-pull-secrets[Allowing pods to reference images from other secured registries].
endif::[]
// need to wait til images docs are added to OSD and ROSA for this link to work
// TODO: remove these conditionals once this is available
ifdef::openshift-dedicated,openshift-rosa[]
* If you are using link:https://quay.io/[Quay.io] as the image registry, you must ensure that either the repository is not private, or that you have allowed pods on your cluster to reference images from other secured registries.
endif::[]

ifdef::openshift-enterprise[]
* If you are using the OpenShift Container Registry, a cluster administrator must link:https://docs.openshift.com/container-platform/latest/registry/securing-exposing-registry.adoc#securing-exposing-registry[expose the registry].
endif::[]
// need to wait til registry docs are added to OSD and ROSA for this link to work
// TODO: remove these conditionals once this is available
ifdef::openshift-dedicated,openshift-rosa[]
* If you are using the OpenShift Container Registry, a cluster or dedicated administrator must expose the registry.
endif::[]
* If you are using link:https://quay.io/[Quay.io] as the image registry, you must ensure that either the repository is not private, or that you have followed the {ocp-product-title} documentation on link:https://docs.openshift.com/container-platform/latest/openshift_images/managing_images/using-image-pull-secrets.html#images-allow-pods-to-reference-images-from-secure-registries_using-image-pull-secrets[Allowing pods to reference images from other secured registries].


* If you are using the OpenShift Container Registry, a cluster administrator must link:https://docs.openshift.com/container-platform/latest/registry/securing-exposing-registry.html#securing-exposing-registry[expose the registry].

include::modules/serverless-functions-podman.adoc[leveloffset=+1]
include::modules/serverless-functions-podman-macos.adoc[leveloffset=+1]

[id="next-steps_serverless-functions-setup"]
== Next steps

ifdef::openshift-enterprise[]
* For more information about Docker Container Engine or Podman, see link:https://docs.openshift.com/container-platform/latest/architecture/understanding-development.adoc#container-build-tool-options[Container build tool options].
endif::[]
// need to wait til build tool docs are added to OSD and ROSA for this link to work
// TODO: remove these conditionals once this is available
* For more information about Docker Container Engine or Podman, see link:https://docs.openshift.com/container-platform/latest/architecture/understanding-development.html#container-build-tool-options[Container build tool options].

* See xref:../functions/serverless-functions-getting-started.adoc#serverless-functions-getting-started[Getting started with functions].
36 changes: 6 additions & 30 deletions install/configuring-serverless-functions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,49 +20,25 @@ To enable the use of {FunctionsProductName} on your cluster, you must complete t
Functions are deployed as a Knative service. If you want to use event-driven architecture with your functions, you must also install Knative Eventing.
====

ifdef::openshift-enterprise[]
* You have the link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[`oc` CLI] installed.
endif::[]
// need to wait til CLI docs are added to OSD and ROSA for this link to work
// TODO: remove these conditionals once this is available
ifdef::openshift-dedicated,openshift-rosa[]
* You have the `oc` CLI installed.
endif::[]
* You have the link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html#cli-getting-started[`oc` CLI] installed.

* You have the xref:../install/installing-kn.adoc#installing-kn[Knative (`kn`) CLI] installed. Installing the Knative CLI enables the use of `kn func` commands which you can use to create and manage functions.

* You have installed Docker Container Engine or Podman version 3.4.7 or higher.

* You have access to an available image registry, such as the OpenShift Container Registry.

ifdef::openshift-enterprise[]
* If you are using link:https://quay.io/[Quay.io] as the image registry, you must ensure that either the repository is not private, or that you have followed the {ocp-product-title} documentation on link:https://docs.openshift.com/container-platform/latest/openshift_images/managing_images/using-image-pull-secrets.adoc#images-allow-pods-to-reference-images-from-secure-registries_using-image-pull-secrets[Allowing pods to reference images from other secured registries].
endif::[]
// need to wait til images docs are added to OSD and ROSA for this link to work
// TODO: remove these conditionals once this is available
ifdef::openshift-dedicated,openshift-rosa[]
* If you are using link:https://quay.io/[Quay.io] as the image registry, you must ensure that either the repository is not private, or that you have allowed pods on your cluster to reference images from other secured registries.
endif::[]

ifdef::openshift-enterprise[]
* If you are using the OpenShift Container Registry, a cluster administrator must link:https://docs.openshift.com/container-platform/latest/registry/securing-exposing-registry.adoc#securing-exposing-registry[expose the registry].
endif::[]
// need to wait til registry docs are added to OSD and ROSA for this link to work
// TODO: remove these conditionals once this is available
ifdef::openshift-dedicated,openshift-rosa[]
* If you are using the OpenShift Container Registry, a cluster or dedicated administrator must expose the registry.
endif::[]
* If you are using link:https://quay.io/[Quay.io] as the image registry, you must ensure that either the repository is not private, or that you have followed the {ocp-product-title} documentation on link:https://docs.openshift.com/container-platform/latest/openshift_images/managing_images/using-image-pull-secrets.html#images-allow-pods-to-reference-images-from-secure-registries_using-image-pull-secrets[Allowing pods to reference images from other secured registries].


* If you are using the OpenShift Container Registry, a cluster administrator must link:https://docs.openshift.com/container-platform/latest/registry/securing-exposing-registry.html#securing-exposing-registry[expose the registry].

include::modules/serverless-functions-podman.adoc[leveloffset=+1]
include::modules/serverless-functions-podman-macos.adoc[leveloffset=+1]

[id="next-steps_configuring-serverless-functions"]
== Next steps

ifdef::openshift-enterprise[]
* For more information about Docker Container Engine or Podman, see link:https://docs.openshift.com/container-platform/latest/architecture/understanding-development.adoc#container-build-tool-options[Container build tool options].
endif::[]
// need to wait til build tool docs are added to OSD and ROSA for this link to work
// TODO: remove these conditionals once this is available
* For more information about Docker Container Engine or Podman, see link:https://docs.openshift.com/container-platform/latest/architecture/understanding-development.html#container-build-tool-options[Container build tool options].

* See xref:../functions/serverless-functions-getting-started.adoc#serverless-functions-getting-started[Getting started with functions].
12 changes: 4 additions & 8 deletions install/install-serverless-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,12 @@ Knative has multiple config maps that are named with the prefix `config-`. All K

The `spec.config` in the Knative custom resources have one `<name>` entry for each config map, named `config-<name>`, with a value which is be used for the config map `data`.



ifdef::openshift-enterprise[]
[id="additional-resources_knative-serving-CR-config"]
[role="_additional-resources"]
== Additional resources
* link:https://docs.openshift.com/container-platform/latest/operators/understanding/crds/crd-managing-resources-from-crds.adoc[Managing resources from custom resource definitions]
* link:https://docs.openshift.com/container-platform/latest/storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage]
* link:https://docs.openshift.com/container-platform/latest/networking/configuring-a-custom-pki.adoc[Configuring a custom PKI]
endif::[]
== Additional resources for {ocp-product-title}
* link:https://docs.openshift.com/container-platform/latest/operators/understanding/crds/crd-managing-resources-from-crds.html[Managing resources from custom resource definitions]
* link:https://docs.openshift.com/container-platform/latest/storage/understanding-persistent-storage.html#understanding-persistent-storage[Understanding persistent storage]
* link:https://docs.openshift.com/container-platform/latest/networking/configuring-a-custom-pki.html[Configuring a custom PKI]

[id="next-steps_install-serverless-operator"]
== Next steps
Expand Down
6 changes: 1 addition & 5 deletions install/installing-kn.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,7 @@ toc::[]

The Knative (`kn`) CLI does not have its own login mechanism. To log in to the cluster, you must install the OpenShift CLI (`oc`) and use the `oc login` command. Installation options for the CLIs may vary depending on your operating system.

ifdef::openshift-enterprise[]
For more information on installing the OpenShift CLI (`oc`) for your operating system and logging in with `oc`, see the link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI getting started] documentation.
endif::[]
// need to wait til CLI docs are added to OSD and ROSA for this link to work
// TODO: remove this conditional once this is available
For more information on installing the OpenShift CLI (`oc`) for your operating system and logging in with `oc`, see the link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html#cli-getting-started[OpenShift CLI getting started] documentation.

{ServerlessProductName} cannot be installed using the Knative (`kn`) CLI. A cluster administrator must install the {ServerlessOperatorName} and set up the Knative components, as described in the xref:../install/install-serverless-operator.adoc#install-serverless-operator[Installing the {ServerlessOperatorName}] documentation.

Expand Down
Loading