Add conversion documentation #448
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
cdrage
force-pushed
the
add-compatibility-table
branch
2 times, most recently
from
655931b to
e09e591
Compare
docs/conversion.md
Outdated
| |-------------------|-----------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| | ||
| | | | | | | | ||
| | Service | | | | | | ||
| | build | | YES | [BuildConfig](https://docs.openshift.com/enterprise/3.1/dev_guide/builds.html#defining-a-buildconfig) | Converts, but local builds are not yet supported. See issue [97](https://github.com/kubernetes-incubator/kompose/issues/97) | |
There was a problem hiding this comment.
Maybe mention that build is supported only for OpenShift.
For Kubernetes build in unsupported
docs/conversion.md
Outdated
| | stop_grace_period | | UNSUPPORTED | | | | ||
| | stop_signal | | UNSUPPORTED | | | | ||
| | sysctls | | UNSUPPORTED | | | | ||
| | ulimits | | UNSUPPORTED | | | |
There was a problem hiding this comment.
Kubernets issue about ulimit support - kubernetes/kubernetes#3595
docs/conversion.md
Outdated
| | | | | | | | ||
| | Service | | | | | | ||
| | build | | YES | [BuildConfig](https://docs.openshift.com/enterprise/3.1/dev_guide/builds.html#defining-a-buildconfig) | Converts, but local builds are not yet supported. See issue [97](https://github.com/kubernetes-incubator/kompose/issues/97) | | ||
| | cap_add, cap_drop | | YES | N/A | | |
There was a problem hiding this comment.
I think there is a mistake in the code. We are reading cap_add and cap_drop but we are not using it anywhere.
PR #468 is adding cap_add and cap_drop to unsupported keys.
docs/conversion.md
Outdated
| | container_name | | YES | Mapped to both [Metadata.Name](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/identifiers.md) and [Deployment.Spec.Containers.Name](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/identifiers.md) | | | ||
| | deploy | v3 | UNSUPPORTED | | Upcoming support started | | ||
| | devices | | UNSUPPORTED | N/A | Not supported within Kubernetes, see this [issue](https://github.com/kubernetes/kubernetes/issues/5607) | | ||
| | depends_on | | UNSUPPORTED | N/A | Elaborate on why this isn't supported and what happens when it's converted. Multiple users in #kompose has voiced concerns | |
There was a problem hiding this comment.
What concerns were voiced?
We have depends_on in unsupported keys. I'm not sure if that is right, maybe yes, maybe no :-D
It needs more explanation.
depends_on defines order in which containers should start. Problem is that there is no way to ensure that in Kubernetes.
Questionis is if it matters or not :-)
docs/conversion.md
Outdated
| | env_file | | UNSUPPORTED | | | | ||
| | environment | | YES | [Pod.Spec.Container.Env](https://kubernetes.io/docs/api-reference/v1/definitions/#_v1_envvar) | | | ||
| | expose | | YES | [Service.Spec.Ports](https://kubernetes.io/docs/api-reference/v1/definitions/#_v1_containerport) | | | ||
| | extends | v2 | UNSUPPORTED | N/A | | |
There was a problem hiding this comment.
Extends is parser thing. So it is possible that we get ServiceConfig from libcompose that is already "extended".
It might be good to test it.
|
we should also have link to this document in readme |
cdrage
force-pushed
the
add-compatibility-table
branch
from
e09e591 to
9562146
Compare
|
@kadel I agree. I'll add an "index" to the README eventually. I've updated the PR based on your comments as well as converted it to a "compact" table instead of having all the spacing everywhere. |
This adds a document regarding all the values which are converted from Docker Compose to Kubernetes / OpenShift. Adding both notes as well as the value that docker-compose is mapped to in Kubernetes / OpenShift.
cdrage
force-pushed
the
add-compatibility-table
branch
from
9562146 to
40a9fbc
Compare
|
@kadel Updated again, I shortened the unsupported column to Y/N as well as labeled the separate sections by boldness (volumes, services, networks, etc.). Looks better now 👍 |
This adds a document regarding all the values which are converted from
Docker Compose to Kubernetes / OpenShift. Adding both notes as well as
the value that docker-compose is mapped to in Kubernetes / OpenShift.