-
Notifications
You must be signed in to change notification settings - Fork 772
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
Add doc for volume size label #935
Conversation
docs/user-guide.md
Outdated
The currently supported options are: | ||
|
||
| Key | Value | | ||
|----------------------|-------------------------------------| | ||
| kompose.service.type | nodeport / clusterip / loadbalancer | | ||
| kompose.service.expose | true / hostname | | ||
| kompose.service.expose.tls-secret | secret name | | ||
| kompose.volume.size | kubernetes supported volume size | | ||
|
||
**Note**: `kompose.service.type` label should be defined with `ports` only, otherwise `kompose` will fail. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This table looks good at the top of paragraph.
docs/user-guide.md
Outdated
@@ -290,9 +290,10 @@ The chart structure is aimed at providing a skeleton for building your Helm char | |||
|
|||
## Labels | |||
|
|||
`kompose` supports Kompose-specific labels within the `docker-compose.yml` file in order to explicitly define a service's behavior upon conversion. | |||
`kompose` supports Kompose-specific labels within the `docker-compose.yml` file in order to | |||
explicitly define the generated resources' behavior upon conversion, like Service, PersistentVolumeClaim... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in order
can be omitted to simplify the text.
What @abitrolly said ^^. Other than those two comments. LGTM. |
84e5461
to
f641582
Compare
@cdrage @abitrolly updated, thanks! |
LGTM! 👍 |
With this should close #872