diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 72c83ef421b3..e99f5255d8d9 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -3534,6 +3534,14 @@ Topics: File: installing-knative-eventing - Name: Removing OpenShift Serverless File: removing-openshift-serverless +# Serving +- Name: Knative Serving + Dir: serving + Topics: + - Name: Knative services overview + File: knative-services-overview + - Name: Creating Knative services + File: creating-knative-services # Knative kn CLI - Name: Knative CLI Dir: cli_tools @@ -3553,8 +3561,6 @@ Topics: - Name: Develop Dir: develop Topics: - - Name: Serverless applications - File: serverless-applications - Name: Autoscaling File: serverless-autoscaling-developer - Name: Traffic management diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml index 9de728b04293..f00c00812ed1 100644 --- a/_topic_maps/_topic_map_osd.yml +++ b/_topic_maps/_topic_map_osd.yml @@ -93,7 +93,7 @@ Topics: File: creating-a-gcp-cluster - Name: Configuring your identity providers File: config-identity-providers -- Name: Revoking privileges and access to an OpenShift Dedicated cluster +- Name: Revoking privileges and access to an OpenShift Dedicated cluster File: osd-revoking-cluster-privileges - Name: Deleting an OpenShift Dedicated cluster File: osd-deleting-a-cluster @@ -164,14 +164,14 @@ Topics: - Name: Upgrading OpenShift Dedicated File: osd-upgrades Distros: openshift-dedicated ---- +--- Name: CI/CD Dir: cicd Distros: openshift-dedicated Topics: - Name: Builds Dir: builds - Distros: openshift-dedicated + Distros: openshift-dedicated Topics: - Name: Setting up additional trusted certificate authorities for builds File: setting-up-trusted-ca @@ -288,11 +288,17 @@ Topics: File: kn-eventing-ref - Name: Functions commands File: kn-func-ref +# Serving +- Name: Knative Serving + Dir: serving + Topics: + - Name: Knative services overview + File: knative-services-overview + - Name: Creating Knative services + File: creating-knative-services - Name: Develop Dir: develop Topics: - - Name: Serverless applications - File: serverless-applications - Name: Autoscaling File: serverless-autoscaling-developer - Name: Traffic management diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index bec4f79612d3..53127ce41f3a 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -261,14 +261,14 @@ Topics: File: rosa-upgrading-sts - Name: Upgrading ROSA File: rosa-upgrading ---- +--- Name: CI/CD Dir: cicd Distros: openshift-rosa Topics: - Name: Builds Dir: builds - Distros: openshift-rosa + Distros: openshift-rosa Topics: - Name: Setting up additional trusted certificate authorities for builds File: setting-up-trusted-ca @@ -487,11 +487,17 @@ Topics: File: kn-eventing-ref - Name: Functions commands File: kn-func-ref +# Serving +- Name: Knative Serving + Dir: serving + Topics: + - Name: Knative services overview + File: knative-services-overview + - Name: Creating Knative services + File: creating-knative-services - Name: Develop Dir: develop Topics: - - Name: Serverless applications - File: serverless-applications - Name: Autoscaling File: serverless-autoscaling-developer - Name: Traffic management diff --git a/modules/creating-serverless-apps-admin-console.adoc b/modules/creating-serverless-apps-admin-console.adoc index 1c8b8d5ddcf9..fdd09a41424e 100644 --- a/modules/creating-serverless-apps-admin-console.adoc +++ b/modules/creating-serverless-apps-admin-console.adoc @@ -1,10 +1,11 @@ // Module included in the following assemblies: // // serverless/admin_guide/serverless-cluster-admin-serving.adoc +// serverless/serving/creating-knative-services.adoc :_content-type: PROCEDURE [id="creating-serverless-apps-admin-console_{context}"] -= Creating serverless applications using the Administrator perspective += Creating Knative services by using the Administrator perspective include::snippets/serverless-apps.adoc[] @@ -12,7 +13,7 @@ After the service is created and the application is deployed, Knative creates an .Prerequisites -To create serverless applications using the *Administrator* perspective, ensure that you have completed the following steps. +To create Knative services using the *Administrator* perspective, ensure that you have completed the following steps. * The {ServerlessOperatorName} and Knative Serving are installed. * You have logged in to the web console and are in the *Administrator* perspective. diff --git a/modules/creating-serverless-apps-kn.adoc b/modules/creating-serverless-apps-kn.adoc index d43d64d8725f..887341b98f65 100644 --- a/modules/creating-serverless-apps-kn.adoc +++ b/modules/creating-serverless-apps-kn.adoc @@ -1,13 +1,13 @@ // Module included in the following assemblies: // -// * serverless/develop/serverless-applications.adoc +// serverless/serving/creating-knative-services.adoc // * serverless/reference/kn-serving-ref.adoc :_content-type: PROCEDURE [id="creating-serverless-apps-kn_{context}"] -= Creating serverless applications by using the Knative CLI += Creating Knative services by using the Knative CLI -Using the Knative (`kn`) CLI to create serverless applications provides a more streamlined and intuitive user interface over modifying YAML files directly. You can use the `kn service create` command to create a basic serverless application. +Using the Knative (`kn`) CLI to create Knative services provides a more streamlined and intuitive user interface over modifying YAML files directly. You can use the `kn service create` command to create a basic serverless application. .Prerequisites diff --git a/modules/creating-serverless-apps-yaml.adoc b/modules/creating-serverless-apps-yaml.adoc index 874b60304db7..976618fff916 100644 --- a/modules/creating-serverless-apps-yaml.adoc +++ b/modules/creating-serverless-apps-yaml.adoc @@ -1,12 +1,12 @@ // Module included in the following assemblies: // -// * serverless/develop/serverless-applications.adoc +// serverless/serving/creating-knative-services.adoc :_content-type: PROCEDURE [id="creating-serverless-apps-yaml_{context}"] -= Creating serverless applications using YAML += Creating Knative services using YAML -Creating Knative resources by using YAML files uses a declarative API, which enables you to describe applications declaratively and in a reproducible manner. To create a serverless application by using YAML, you must create a YAML file that defines a Knative `Service` object, then apply it by using `oc apply`. +Creating Knative resources by using YAML files uses a declarative API, which enables you to describe applications declaratively and in a reproducible manner. To create a Knative service by using YAML, you must create a YAML file that defines a Knative `Service` object, then apply it by using `oc apply`. After the service is created and the application is deployed, Knative creates an immutable revision for this version of the application. Knative also performs network programming to create a route, ingress, service, and load balancer for your application and automatically scales your pods up and down based on traffic. diff --git a/modules/kn-service-offline-create.adoc b/modules/kn-service-offline-create.adoc index 5417ce8f3412..f5cbdbf6eab7 100644 --- a/modules/kn-service-offline-create.adoc +++ b/modules/kn-service-offline-create.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // // * serverless/reference/kn-serving-ref.adoc -// * serverless/develop/serverless-applications.adoc +// * serverless/serving/creating-knative-services.adoc :_content-type: PROCEDURE [id="creating-an-offline-service_{context}"] diff --git a/modules/verifying-serverless-app-deployment.adoc b/modules/verifying-serverless-app-deployment.adoc index 9e13fabc8e9c..491c6e0655f3 100644 --- a/modules/verifying-serverless-app-deployment.adoc +++ b/modules/verifying-serverless-app-deployment.adoc @@ -1,12 +1,12 @@ // Module included in the following assemblies: // -// serverless/develop/serverless-applications.adoc +// serverless/serving/creating-knative-services.adoc :_content-type: PROCEDURE [id="verifying-serverless-app-deployment_{context}"] -= Verifying your serverless application deployment += Verifying your Knative service deployment -To verify that your serverless application has been deployed successfully, you must get the application URL created by Knative, and then send a request to that URL and observe the output. {ServerlessProductName} supports the use of both HTTP and HTTPS URLs, however the output from `oc get ksvc` always prints URLs using the `http://` format. +To verify that your Knative service has been deployed successfully, you must get the application URL created by Knative, and then send a request to that URL and observe the output. {ServerlessProductName} supports the use of both HTTP and HTTPS URLs, however the output from `oc get ksvc` always prints URLs using the `http://` format. .Prerequisites diff --git a/serverless/admin_guide/serverless-admin-perspective.adoc b/serverless/admin_guide/serverless-admin-perspective.adoc index 4f5d760729cb..f118bc95598b 100644 --- a/serverless/admin_guide/serverless-admin-perspective.adoc +++ b/serverless/admin_guide/serverless-admin-perspective.adoc @@ -26,7 +26,6 @@ include::modules/serverless-creating-subscription-admin-web-console.adoc[levelof [id="additional-resources_serverless-cluster-admin-eventing"] [role="_additional-resources"] == Additional resources -* xref:../../serverless/develop/serverless-applications.adoc#serverless-applications[Serverless applications] * xref:../../serverless/discover/knative-event-sources.adoc#knative-event-sources[Event sources] * xref:../../serverless/develop/serverless-using-brokers.adoc#serverless-using-brokers[Brokers] * xref:../../serverless/develop/serverless-triggers.adoc#serverless-triggers[Triggers] diff --git a/serverless/develop/serverless-applications.adoc b/serverless/serving/creating-knative-services.adoc similarity index 58% rename from serverless/develop/serverless-applications.adoc rename to serverless/serving/creating-knative-services.adoc index 1ca40f9280e9..4e1510efefc5 100644 --- a/serverless/develop/serverless-applications.adoc +++ b/serverless/serving/creating-knative-services.adoc @@ -1,14 +1,14 @@ :_content-type: ASSEMBLY -[id="serverless-applications"] -= Serverless applications +[id="creating-knative-services"] += Creating Knative services +:context: creating-knative-services include::_attributes/common-attributes.adoc[] -:context: serverless-applications toc::[] include::snippets/serverless-apps.adoc[] -You can create a serverless application by using one of the following methods: +You can create a Knative service by using one of the following methods: * Create a Knative service from the {product-title} web console. + @@ -18,32 +18,22 @@ endif::[] * Create a Knative service by using the Knative (`kn`) CLI. * Create and apply a Knative `Service` object as a YAML file, by using the `oc` CLI. +// admin console +include::modules/creating-serverless-apps-admin-console.adoc[leveloffset=+1] // create service using CLI include::modules/creating-serverless-apps-kn.adoc[leveloffset=+1] - // offline mode include::modules/kn-service-offline-create.adoc[leveloffset=+1] - // create service using YAML include::modules/creating-serverless-apps-yaml.adoc[leveloffset=+1] include::modules/verifying-serverless-app-deployment.adoc[leveloffset=+1] -include::modules/interacting-serverless-apps-http2-gRPC.adoc[leveloffset=+1] - -// OCP only -ifdef::openshift-enterprise[] -// Using Knative services w/ restrictive NetworkPolicies -include::modules/serverless-services-network-policies.adoc[leveloffset=+1] -endif::[] -// move to admin guide, outside scope of this PR - -// config init containers -include::modules/serverless-init-containers-apps.adoc[leveloffset=+1] -// HTTPS redirection -include::modules/serverless-https-redirect-service.adoc[leveloffset=+1] -[id="additional-resources_serverless-applications"] +[id="additional-resources_understanding-services"] [role="_additional-resources"] == Additional resources +ifdef::openshift-enterprise[] +* xref:../../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-extending-api-with-crds[Extending the Kubernetes API with custom resource definitions] +* xref:../../operators/understanding/crds/crd-managing-resources-from-crds.adoc#crd-managing-resources-from-crds[Managing resources from custom resource definitions] +endif::[] * xref:../../serverless/cli_tools/kn-serving-ref.adoc#kn-serving-ref[Knative Serving CLI commands] -* xref:../../serverless/security/serverless-ossm-with-kourier-jwt.adoc#serverless-ossm-with-kourier-jwt[Configuring JSON Web Token authentication for Knative services] diff --git a/serverless/serving/knative-services-overview.adoc b/serverless/serving/knative-services-overview.adoc new file mode 100644 index 000000000000..2001a3cecf90 --- /dev/null +++ b/serverless/serving/knative-services-overview.adoc @@ -0,0 +1,23 @@ +:_content-type: ASSEMBLY +[id="understanding-knative-services"] += Knative services overview +:context: understanding-knative-services +include::_attributes/common-attributes.adoc[] + +toc::[] + +include::snippets/serverless-apps.adoc[] + +include::modules/interacting-serverless-apps-http2-gRPC.adoc[leveloffset=+1] + +// OCP only +ifdef::openshift-enterprise[] +// Using Knative services w/ restrictive NetworkPolicies +include::modules/serverless-services-network-policies.adoc[leveloffset=+1] +endif::[] +// move to admin guide, outside scope of this PR + +// config init containers +include::modules/serverless-init-containers-apps.adoc[leveloffset=+1] +// HTTPS redirection +include::modules/serverless-https-redirect-service.adoc[leveloffset=+1] diff --git a/snippets/serverless-apps.adoc b/snippets/serverless-apps.adoc index 62e9ac76b1e6..08cd8ac43b59 100644 --- a/snippets/serverless-apps.adoc +++ b/snippets/serverless-apps.adoc @@ -1,6 +1,7 @@ // Text snippet included in the following modules and assemblies: // -// * /serverless/develop/serverless-applications.adoc +// * /serverless/serving/understanding-knative-services.adoc +// * /serverless/serving/creating-knative-services.adoc // * /modules/creating-serverless-apps-admin-console.adoc :_content-type: SNIPPET