Skip to content
This repository was archived by the owner on Nov 22, 2024. It is now read-only.

Kubernetes docs#953

Merged
RayRoestenburg merged 36 commits into
masterfrom
kubernetes-docs
Jan 20, 2021
Merged

Kubernetes docs#953
RayRoestenburg merged 36 commits into
masterfrom
kubernetes-docs

Conversation

@franciscolopezsancho

Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

adding annotation and ports documentation while taking kubernates configuration out of the current page

Why are the changes needed?

to explain the new capabilities and ease the read

Does this PR introduce any user-facing change?

yes the docs

How was this patch tested?

running the local-preview

In this section we are covering the different Kubernetes parameters that are configurable.

To set the configuration on a container related to Kubernetes is necessary, first of all, to add that configuration under `cloudflow.streamlets.[streamlet-name].kubernetes`.
On the followint samples we show configurations under a specific streamlet, `my-streamlet`, that in its complete path is `cloudflow.streamlets.my-streamlet`. It is also possible, as explained in xref:develop:cloudflow-configuration.adoc#_configuring_a_runtime_using_the_runtime_scope[Configuring a Runtime using the runtime Scope], to apply any configuration shown in here to any `runtimes`. The complete path for a runtime is, for instance, `cloudflow.runtimes.akka`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
On the followint samples we show configurations under a specific streamlet, `my-streamlet`, that in its complete path is `cloudflow.streamlets.my-streamlet`. It is also possible, as explained in xref:develop:cloudflow-configuration.adoc#_configuring_a_runtime_using_the_runtime_scope[Configuring a Runtime using the runtime Scope], to apply any configuration shown in here to any `runtimes`. The complete path for a runtime is, for instance, `cloudflow.runtimes.akka`.
On the following samples we show configurations under a specific streamlet, `my-streamlet`, that in its complete path is `cloudflow.streamlets.my-streamlet`. It is also possible, as explained in xref:develop:cloudflow-configuration.adoc#_configuring_a_runtime_using_the_runtime_scope[Configuring a Runtime using the runtime Scope], to apply any configuration shown in here to any `runtimes`. The complete path for a runtime is, for instance, `cloudflow.runtimes.akka`.

To set the configuration on a container related to Kubernetes is necessary, first of all, to add that configuration under `cloudflow.streamlets.[streamlet-name].kubernetes`.
On the followint samples we show configurations under a specific streamlet, `my-streamlet`, that in its complete path is `cloudflow.streamlets.my-streamlet`. It is also possible, as explained in xref:develop:cloudflow-configuration.adoc#_configuring_a_runtime_using_the_runtime_scope[Configuring a Runtime using the runtime Scope], to apply any configuration shown in here to any `runtimes`. The complete path for a runtime is, for instance, `cloudflow.runtimes.akka`.

=== Resources and Environment Variables

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please create separate sections for configuring resources and configuring environment variables.
"Configure container resource requests and limits" could be a title for one, "Configure container environment variables" for the other.

In this section we are covering the different Kubernetes parameters that are configurable.

To set the configuration on a container related to Kubernetes is necessary, first of all, to add that configuration under `cloudflow.streamlets.[streamlet-name].kubernetes`.
On the followint samples we show configurations under a specific streamlet, `my-streamlet`, that in its complete path is `cloudflow.streamlets.my-streamlet`. It is also possible, as explained in xref:develop:cloudflow-configuration.adoc#_configuring_a_runtime_using_the_runtime_scope[Configuring a Runtime using the runtime Scope], to apply any configuration shown in here to any `runtimes`. The complete path for a runtime is, for instance, `cloudflow.runtimes.akka`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
On the followint samples we show configurations under a specific streamlet, `my-streamlet`, that in its complete path is `cloudflow.streamlets.my-streamlet`. It is also possible, as explained in xref:develop:cloudflow-configuration.adoc#_configuring_a_runtime_using_the_runtime_scope[Configuring a Runtime using the runtime Scope], to apply any configuration shown in here to any `runtimes`. The complete path for a runtime is, for instance, `cloudflow.runtimes.akka`.
In the following examples we show configurations for a specific streamlet named `my-streamlet`, under `cloudflow.streamlets.my-streamlet`. It is also possible, as explained in xref:develop:cloudflow-configuration.adoc#_configuring_a_runtime_using_the_runtime_scope[Configuring a Runtime using the runtime Scope], to apply any configuration shown here to a specific `runtime`. For example, Kubernetes settings for all akka streamlets can be set under`cloudflow.runtimes.akka.kubernetes`.

@RayRoestenburg RayRoestenburg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please accept my suggestions, looks good otherwise.

…w-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>
@RayRoestenburg

Copy link
Copy Markdown
Contributor

Also please create separate sections for configuring resources and configuring environment variables @franciscolopezsancho better for searching and simpler to read one thing at a time.

…w-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

@RayRoestenburg RayRoestenburg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor changes to be made, good improvements!

franciscolopezsancho and others added 5 commits January 20, 2021 09:11
…w-configuration.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>
…w-configuration.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>
…w-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>
…w-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>
…sing same terms in different places for cohesion
@franciscolopezsancho

Copy link
Copy Markdown
Contributor Author

back at you :) @RayRoestenburg

Comment thread docs/docs-source/docs/modules/ROOT/nav.adoc Outdated
Comment thread docs/docs-source/docs/modules/develop/pages/streamlet-configuration.adoc Outdated

@RayRoestenburg RayRoestenburg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some final comments!

franciscolopezsancho and others added 8 commits January 20, 2021 15:59
Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>
…w-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>
…w-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>
…w-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>
…w-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>
…w-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>
@RayRoestenburg RayRoestenburg merged commit f22030c into master Jan 20, 2021
@RayRoestenburg RayRoestenburg deleted the kubernetes-docs branch January 20, 2021 17:16
RayRoestenburg added a commit that referenced this pull request Jan 21, 2021
* first commit

* reviewing links and content

* first draft

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* dividing and conquering

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* accepted changes and cleaned a bit, rephrasing couple of things and using same terms in different places for cohesion

* Update docs/docs-source/docs/modules/ROOT/nav.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>

* Update docs/docs-source/docs/modules/develop/pages/streamlet-configuration.adoc

* Update docs/shared-content-source/docs/modules/develop/pages/cloudflow-configuration-kubernetes.adoc

Co-authored-by: Raymond Roestenburg <raymond.roestenburg@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants