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

Update recipes documentation to add deployments and configmaps #647

Merged
merged 1 commit into from
Jan 9, 2019

Conversation

amisevsk
Copy link
Contributor

What does this PR do?

Update documentation for Kubernetes YAML recipes to include deployments and configmap as supported objects.

Main PR: eclipse-che/che#12203

What issues does this PR fix or reference?

eclipse-che/che#11505 and eclipse-che/che#11507

Update documentation for Kubernetes YAML recipes to include deployments
and configmap as supported objects.

Signed-off-by: Angel Misevski <[email protected]>
@@ -156,50 +156,78 @@ The `env_file` Compose option is not supported. Environment variables can be man
[id="kubernetes-yaml-limitations-and-restrictions"]
== Kubernetes YAML limitations and restrictions

When a workspace is starting, Che creates a https://kubernetes.io/docs/concepts/workloads/pods/pod/[Kubernetes pod]. The following are limitatons and restrictions:
When a workspace is starting, Che creates various Kubernetes resources to support the IDE and development tools. Workspaces primarily consist of a https://kubernetes.io/docs/concepts/workloads/controllers/deployment/[Deployment] which runs a https://kubernetes.io/docs/concepts/workloads/pods/pod/[Kubernetes pod]. The following are limitatons and restrictions:
Copy link
Member

Choose a reason for hiding this comment

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

@amisevsk maybe it would be a good idea to add info about replicas limitations that should only be 1 ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We could; I didn't add it because I think it's kind of common sense, and the validator will block stack creation, and currently KubernetesDeployments will directly set replicas to 1 if you happen to modify it.

I would rather keep the docs as short as possible and only cover the weird cases we require.

@amisevsk amisevsk merged commit 7296682 into eclipse-che:master Jan 9, 2019
@amisevsk amisevsk deleted the issue-11505 branch January 9, 2019 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants