diff --git a/_topic_map.yml b/_topic_map.yml index 36b574c89e..21e429fcd7 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -1445,7 +1445,7 @@ Topics: - Name: Configuring Knative Serving autoscaling File: configuring-knative-serving-autoscaling ### Using Knative Client -- Name: Using Knative Client +- Name: Getting started with Knative Client File: knative-client ### Release Notes - Name: Release Notes diff --git a/images/question-circle.png b/images/question-circle.png new file mode 100644 index 0000000000..a505ba1fca Binary files /dev/null and b/images/question-circle.png differ diff --git a/modules/kubefed-document-attributes.adoc b/modules/kubefed-document-attributes.adoc deleted file mode 100644 index 01feb68e43..0000000000 --- a/modules/kubefed-document-attributes.adoc +++ /dev/null @@ -1,25 +0,0 @@ -// Standard document attributes to be used in the documentation -// -// The following are shared by all documents: -:toc: -:toclevels: 4 -:experimental: -// -// Product content attributes, that is, substitution variables in the files. -// -:KubeFedProductName: OpenShift KubeFed -:KubeFedProductShortName: KubeFed -// -// Documentation publishing attributes used in the master-docinfo.xml file -// Note that the DocInfoProductName generates the URL for the product page. -// Changing the value changes the generated URL. -// -:DocInfoProductName: OpenShift KubeFed -// -// Book Names: -// Defining the book names in document attributes instead of hard-coding them in -// the master.adoc files and in link references. This makes it easy to change the -// book name if necessary. -// Using the pattern ending in 'BookName' makes it easy to grep for occurrences -// throughout the topics -// diff --git a/modules/serverless-installing-cli-web-console.adoc b/modules/serverless-installing-cli-web-console.adoc new file mode 100644 index 0000000000..82d6e6f2db --- /dev/null +++ b/modules/serverless-installing-cli-web-console.adoc @@ -0,0 +1,35 @@ +// Module is included in the following assemblies: +// +// serverless/knative-client.adoc + +[id="installing-cli-web-console_{context}"] += Installing the `kn` CLI using the {product-title} web console + +Once the {ServerlessOperatorName} is installed, you will see a link to download the `kn` CLI for Linux, macOS and Windows from the *Command Line Tools* page in the {product-title} web console. + +You can access the *Command Line Tools* page by clicking the image:../images/question-circle.png[title="Help"] icon in the top right corner of the web console and selecting *Command Line Tools* in the drop down menu. + +.Procedure + +. Download the `kn` CLI from the *Command Line Tools* page. +. Unpack the archive: ++ +---- +$ tar -xf +---- +. Move the `kn` binary to a directory on your PATH. + +. To check your path, run: ++ +---- +$ echo $PATH +---- ++ +[NOTE] +==== +If you do not use RHEL or Fedora, ensure that *libc* is installed in a directory on your library path. +If *libc* is not available, you might see the following error when you run CLI commands: +---- +$ kn: No such file or directory +---- +==== diff --git a/serverless/knative-client.adoc b/serverless/knative-client.adoc index 5622e693be..a804e68d05 100644 --- a/serverless/knative-client.adoc +++ b/serverless/knative-client.adoc @@ -1,26 +1,29 @@ [id="knative-client"] -= Using Knative Client += Getting started with Knative Client include::modules/common-attributes.adoc[] :context: knative-client toc::[] -Knative Client (`kn`) is the Knative command line interface (CLI). The CLI exposes commands for managing your applications, as well as lower level tools to interact with components of {product-title}. With `kn`, you can create applications and manage {product-title} projects from the terminal. +Knative Client (`kn`) is the Knative command line interface (CLI). +The CLI exposes commands for managing your applications, as well as lower level tools to interact with components of {product-title}. +With `kn`, you can create applications and manage {product-title} projects from the terminal. -Knative client does not have its own log in mechanism. To log in to the cluster you must install the `oc` CLI and use the `oc` login. Installation options for the CLI vary depending on your operating system. +== Before you begin +Knative Client does not have its own log in mechanism. +To log in to the cluster you must install the `oc` CLI and use `oc` login. -// Installation -include::modules/cli-installing-cli.adoc[leveloffset=+1] -include::modules/serverless-installing-cli-linux.adoc[leveloffset=+2] +Installation options for the `oc` CLI will vary depending on your operating system. +For more information on installing the `oc` CLI for your operating system and logging in with `oc`, see the xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[CLI getting started] documentation. + +== Installing Knative Client +include::modules/serverless-installing-cli-web-console.adoc[leveloffset=+2] include::modules/serverless-installing-cli-linux-rpm.adoc[leveloffset=+2] +include::modules/serverless-installing-cli-linux.adoc[leveloffset=+2] include::modules/serverless-installing-cli-macos.adoc[leveloffset=+2] include::modules/serverless-installing-cli-windows.adoc[leveloffset=+2] -// Log in -include::modules/cli-logging-in.adoc[leveloffset=+1] - - // Access workflows after installation // Basic Workflow include::modules/serverless-workflow-basic.adoc[leveloffset=+1]