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.

Sign up for GitHub

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

Add summary section for local kubernetes #34157

Merged
merged 1 commit into from
Sep 22, 2023
Merged

Add summary section for local kubernetes #34157

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 20 additions & 2 deletions docs/src/main/asciidoc/deploying-to-kubernetes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -958,11 +958,29 @@
----

<1> In this example, the cluster role "my-cluster-role" will be generated with the specified policy rules.
<2> The name of the ClusterRole resource to use. Role resources are namespace-based and hence not allowed in ClusterRoleBinding resources.

Check warning on line 961 in docs/src/main/asciidoc/deploying-to-kubernetes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'Deploying to local Kubernetes'.

Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Deploying to local Kubernetes'.", "location": {"path": "docs/src/main/asciidoc/deploying-to-kubernetes.adoc", "range": {"start": {"line": 961, "column": 112}}}, "severity": "INFO"}

=== Deploying to Minikube
=== Deploying to local Kubernetes

When deploying to local Kubernetes environments, users often perform minor changes to their manifests that simplify the development process.
The most common changes are:

- Setting `imagePullPolicy` to `IfNotPresent`
- Using `NodePort` as `Service` type

Quarkus provides extensions that among others set these options by default.
Such extensions are:

- quarkus-minikube
- quarkus-kind

If the list of extensions does not match the tool you are using (e.g. Docker Desktop, microk8s etc) then it is suggested to use the `quarkus-minikube` extension.

Check warning on line 977 in docs/src/main/asciidoc/deploying-to-kubernetes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.", "location": {"path": "docs/src/main/asciidoc/deploying-to-kubernetes.adoc", "range": {"start": {"line": 977, "column": 25}}}, "severity": "INFO"}

Check warning on line 977 in docs/src/main/asciidoc/deploying-to-kubernetes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'for example' rather than 'e.g.' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'for example' rather than 'e.g.' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/deploying-to-kubernetes.adoc", "range": {"start": {"line": 977, "column": 33}}}, "severity": "WARNING"}

Check warning on line 977 in docs/src/main/asciidoc/deploying-to-kubernetes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'and so on' rather than 'etc' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'and so on' rather than 'etc' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/deploying-to-kubernetes.adoc", "range": {"start": {"line": 977, "column": 63}}}, "severity": "WARNING"}

Check warning on line 977 in docs/src/main/asciidoc/deploying-to-kubernetes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/deploying-to-kubernetes.adoc", "range": {"start": {"line": 977, "column": 130}}}, "severity": "INFO"}
as its defaults should be reasonable for most environments.


==== Deploying to Minikube

https://github.com/kubernetes/minikube[Minikube] is quite popular when a Kubernetes cluster is needed for development purposes. To make the deployment to Minikube

Check warning on line 983 in docs/src/main/asciidoc/deploying-to-kubernetes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/deploying-to-kubernetes.adoc", "range": {"start": {"line": 983, "column": 142}}}, "severity": "INFO"}
experience as frictionless as possible, Quarkus provides the `quarkus-minikube` extension. This extension can be added to a project like so:

[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"]
Expand Down Expand Up @@ -1005,11 +1023,11 @@
WARNING: It is highly discouraged to use the manifests generated by the Minikube extension when deploying to production as these manifests are intended for development purposes
only. When deploying to production, consider using the vanilla Kubernetes manifests (or the OpenShift ones when targeting OpenShift).

NOTE: If the assumptions the Minikube extension makes don't fit your workflow, nothing prevents you from using the regular Kubernetes extension to generate Kubernetes manifests

Check warning on line 1026 in docs/src/main/asciidoc/deploying-to-kubernetes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.", "location": {"path": "docs/src/main/asciidoc/deploying-to-kubernetes.adoc", "range": {"start": {"line": 1026, "column": 61}}}, "severity": "INFO"}
and apply those to your Minikube cluster.

=== Deploying to Kind
==== Deploying to Kind
https://kind.sigs.k8s.io/[Kind] is another popular tool used as a Kubernetes cluster for development purposes. To make the deployment to Kind

Check warning on line 1030 in docs/src/main/asciidoc/deploying-to-kubernetes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/deploying-to-kubernetes.adoc", "range": {"start": {"line": 1030, "column": 18}}}, "severity": "INFO"}
experience as frictionless as possible, Quarkus provides the `quarkus-kind` extension. This extension can be added to a project like so:

[source,xml]
Expand Down
Loading