Add doc for volume size label #935
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abitrolly
reviewed
Feb 15, 2018
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.
This table looks good at the top of paragraph.
abitrolly
reviewed
Feb 15, 2018
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.
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! 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With this should close #872