Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: cleaning #2778

Merged
merged 1 commit into from
Nov 24, 2021
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: 2 additions & 3 deletions docs/modules/ROOT/nav-end.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
** xref:troubleshooting/operating.adoc[Operating]
** xref:troubleshooting/known-issues.adoc[Known Issues]
* xref:kamelets/kamelets.adoc[Kamelets]
** xref:kamelets/kamelets-user.adoc[Kamelets User Guide]
** xref:kamelets/kamelets-dev.adoc[Kamelets Developer Guide]
** xref:kamelets/kamelets-user.adoc[User Guide]
** xref:kamelets/kamelets-dev.adoc[Developer Guide]
* xref:architecture/architecture.adoc[Architecture]
** xref:architecture/operator.adoc[Operator]
*** xref:architecture/cr/integration-platform.adoc[IntegrationPlatform]
Expand All @@ -14,7 +14,6 @@
*** xref:architecture/cr/camel-catalog.adoc[CamelCatalog]
** xref:architecture/runtime.adoc[Runtime]
** xref:architecture/traits.adoc[Traits]
** xref:architecture/advanced.adoc[Advanced Installation]
* xref:apis/camel.adoc[API]
* xref:uninstalling.adoc[Uninstalling]
* xref:contributing/developers.adoc[Contributing]
Expand Down
32 changes: 18 additions & 14 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@
* xref:installation/installation.adoc[Installation]
** xref:installation/minikube.adoc[Minikube]
** xref:installation/crc.adoc[Red Hat CodeReady Containers (CRC)]
** xref:installation/digitalocean.adoc[DigitalOcean Kubernetes Cluster]
** xref:installation/gke.adoc[Google Kubernetes Engine (GKE)]
** xref:installation/openshift.adoc[OpenShift]
** xref:installation/iks.adoc[IBM Kubernetes Service (IKS)]
** xref:installation/k3s.adoc[K3s]
** xref:installation/kind.adoc[Kind]
** Kubernetes Platform
*** xref:installation/platform/minikube.adoc[Minikube]
*** xref:installation/platform/crc.adoc[CRC]
*** xref:installation/platform/digitalocean.adoc[DigitalOcean]
*** xref:installation/platform/gke.adoc[GKE]
*** xref:installation/platform/openshift.adoc[OpenShift]
*** xref:installation/platform/iks.adoc[IKS]
*** xref:installation/platform/k3s.adoc[K3s]
*** xref:installation/platform/kind.adoc[Kind]
** xref:installation/registry/registry.adoc[Configuring Registry]
*** xref:installation/registry/digitalocean.adoc[DigitalOcean]
*** xref:installation/registry/dockerhub.adoc[Docker Hub]
*** xref:installation/registry/github.adoc[Github Packages]
*** xref:installation/registry/gcr.adoc[Gcr.io]
*** xref:installation/registry/icr.adoc[IBM Container Registry]
*** xref:installation/registry/k3s.adoc[K3s]
** xref:installation/scheduling.adoc[Pod scheduling]
* xref:running/running.adoc[Running]
** xref:running/dev-mode.adoc[Dev Mode]
** xref:running/run-from-github.adoc[Run from GitHub]
* xref:tutorials/tutorials.adoc[Tutorials]
* xref:cli/cli.adoc[CLI]
** Advanced
*** xref:installation/advanced/resources.adoc[Resource management]
*** xref:architecture/advanced/multi.adoc[Multiple Operators]
* Command Line Interface
** xref:cli/cli.adoc[Kamel CLI]
** xref:cli/modeline.adoc[Modeline]
* xref:running/running.adoc[Run an Integration]
** xref:running/dev-mode.adoc[Developer mode]
** xref:running/run-from-github.adoc[Run from GitHub]
** xref:tutorials/tutorials.adoc[Examples]
* xref:configuration/configuration.adoc[Configuration]
** xref:configuration/build-time-properties.adoc[Build time properties]
** xref:configuration/components.adoc[Components]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/cli/cli.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Camel K CLI (kamel)

The Camel K command line interface (kamel) is the main entry point for running integrations on a Kubernetes cluster.
The Camel K command line interface, `kamel`, is the main entry point for running integrations on a Kubernetes cluster.

Releases of the Camel K CLI are available on:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
[[advanced-installation]]
= Advanced Installation

This section provides information about special installation modes for the Camel K operator.
These are advanced configuration options that normally are not needed by Camel K users,
but they may be useful for particular use cases.

[[advanced-installation-multiple-operators]]
== Multiple Operators and Selective Upgrades

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[scheduling-infra-pod]]
= Scheduling infrastructure Pods and Resource managment
= Infrastructure Pods and Resource managment

During the installation procedure you will be able to provide information on how to best "operationalize" your infrastructure. Through the configuration of `--node-selector`, `--toleration` and `--operator-resources` you will be able to drive the operator `Pods` scheduling and to be able to assign resources.

Expand Down
5 changes: 5 additions & 0 deletions docs/modules/ROOT/pages/installation/installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,8 @@ You're now ready to xref:running/running.adoc[run some integrations].

Camel K is also available in Helm Hub for installation.
Follow the instructions on the https://hub.helm.sh/charts/camel-k/camel-k[Camel K] page for more information.

[[advanced]]
== Advanced configuration

Camel K installation can be configured with certain special settings available for experienced users. You can manage resources such as limiting memory and CPU, provide a policy for `Pod` scheduling and `Toleration`. You can also configure the application to run multiple operators on the same namespace. Have a look at the "advanced" section under the "installation" menu.
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/running/dev-mode.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[dev-mode]]
= Running in Dev Mode
= Running an Integration in Dev Mode

Camel K provides a specific flag for quickly iterating on integrations during development and have fast feedbacks on the code you're writing.
It's called *dev mode*.
Expand Down
8 changes: 4 additions & 4 deletions docs/modules/ROOT/pages/running/run-from-github.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[[run-from-github]]
= Run from GitHub
= Run an Integration from GitHub

It is possible to run integrations from a GitHub repository or Gist with dedicated URL syntax:

== Repository
== Integration code stored in a Github repository

.Syntax
[source]
Expand All @@ -30,7 +30,7 @@ but does not require to type the full GitHub RAW URL.

Declaring the branch query param is not required and defaults to `master` if not explicit set.

== Gist
== Integration code stored in a Gist

.Syntax
[source]
Expand All @@ -39,7 +39,7 @@ kamel run https://gist.github.com/${user-id}/${gist-id}
kamel run gist:${gist-id}
----

camel-k will add any file that is part of the Gist as a source.
Camel k will add any file that is part of the Gist as a source.

As example, assuming there are two files listed as part of a Gist, beans.yaml and routes.yaml, then the following command

Expand Down
30 changes: 23 additions & 7 deletions docs/modules/ROOT/pages/running/running.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[[running]]
= Running
[[running-integration]]
= Running an Integration

After completing the xref:installation/installation.adoc[installation] you should be connected to a Kubernetes/OpenShift cluster
and have the "kamel" CLI correctly configured.
and have the `kamel` CLI correctly configured.

Ensure you're connected to the cluster by executing a simple command using the Kubernetes CLI:

Expand All @@ -28,15 +28,31 @@ You can run it on the cluster by executing:
kamel run hello.groovy
```

Integrations can be written in multiple languages. We provide an archive with common examples in the https://github.com/apache/camel-k/releases[release page].
Integrations can be written in multiple languages. We are collecting examples in our https://github.com/apache/camel-k/[Github repository].

You can change the content of the `hello.groovy` file and execute the command again to see the changes, or use the xref:running/dev-mode.adoc[dev mode] to have even quicker turnaround times.

== Monitoring the Status
[[monitoring-integration]]
== Monitoring the application status

Camel K integrations follow a lifecycle composed of several steps before getting into the `Running` state.

You can check the status of all integrations by executing the following command:

```
kamel get
```

[[logging-integration]]
== Log the standard output

Camel K integrations follow a lifecycle composed of several steps before getting into the `Running` state.

You can check the status of all integrations by executing the following command:

```
kamel logs hello
```

[[dev-mode-integration]]
== Running an Integration in Development mode

Camel K provide a very nice **dev mode** feature that will allow you to apply any change to your Integration code reactively. Check out the xref:running/dev-mode.adoc[Camel K dev mode]