Skip to content

Update README with all parameters and add liveness delay parameter #2

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

Merged
merged 2 commits into from
Sep 14, 2017
Merged

Update README with all parameters and add liveness delay parameter #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78ec896
Add liveness Delay for slow systems. Correct README chart parameters
parrobe Sep 14, 2017
55c3a9b
Add resource parameters to readme
parrobe Sep 14, 2017
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
16 changes: 11 additions & 5 deletions charts/mq-advancedserver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,24 @@ kubectl delete pvc -l release=foo
The following table lists the configurable parameters of the `mq-advancedserver` chart and their default values.

| Parameter | Description | Default |
| ---------------------------- | --------------------------------------------- | ---------------------------------------------------------- |
| `license` | Set to `accept` to accept the terms of the IBM license | `not accepted` |
| `image.name` | Image name | `nil` |
| ------------------------------- | ----------------------------------------------- | ---------------------------------------------------------- |
| `license` | Set to `accept` to accept the terms of the IBM license | `not accepted` |
| `image.repository` | Image full name including repository | `nil` |
| `image.tag` | Image tag | `nil` |
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
| `image.pullSecret` | Image pull secret, if you are using a private Docker registry | `nil` |
| `data.persistence.enabled` | Use a PersistentVolume to persist MQ data (under `/var/mqm`) | `true` |
| `data.persistence.storageClass` | Storage class of backing Persistent Volume | `nil` |
| `data.persistence.storageClass` | Storage class of backing Persistent Volume | `nil` |
| `data.persistence.size` | Size of data volume | `2Gi` |
| `service.name` | Name of the Kubernetes service to create | `qmgr` |
| `service.type` | Kubernetes service type exposing ports, e.g. `NodePort` | `ClusterIP` |
| `queueManager.name` | MQ Queue Manager name | Helm release name |
| `resources.limits.cpu` | Kubernetes CPU limit for the Queue Manager container | `1` |
| `resources.limits.memory` | Kubernetes memory limit for the Queue Manager container | `1Gi` |
| `resources.requests.cpu` | Kubernetes CPU request for the Queue Manager container | `1` |
| `resources.requests.memory` | Kubernetes memory request for the Queue Manager container | `1Gi` |
| `queueManager.name` | MQ Queue Manager name | Helm release name |
| `nameOverride` | Set to partially override the resource names used in this chart | `nil` |
| `livenessDelay` | Raises the time out before Kubernetes checks for Queue Manager's health. Useful for slower systems that take longer to start the Queue Manager. | 60 |

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.

Expand Down
8 changes: 4 additions & 4 deletions charts/mq-advancedserver/templates/stateful-set.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ spec:
containers:
- name: qmgr
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
imagePullPolicy: {{ .Values.image.pullPolicy }}
imagePullPolicy: {{ .Values.image.pullPolicy }}
ports:
- containerPort: 1414
env:
Expand All @@ -56,9 +56,9 @@ spec:
# Set liveness probe to determine if the queue manager is running
livenessProbe:
exec:
command:
command:
- chkmqhealthy
initialDelaySeconds: 60
initialDelaySeconds: {{ .Values.livenessDelay }}
periodSeconds: 10
timeoutSeconds: 5
failureThreshold: 1
Expand Down Expand Up @@ -92,5 +92,5 @@ spec:
accessModes: [ "ReadWriteOnce" ]
resources:
requests:
storage: {{ .Values.data.persistence.size | quote }}
storage: {{ .Values.data.persistence.size | quote }}
{{- end }}
8 changes: 5 additions & 3 deletions charts/mq-advancedserver/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
license: "not accepted"
image:
# repository is the container repository to use, which must contain IBM MQ Advanced
repository:
repository:
# tag is the tag to use for the container repository
tag:
# pullSecret is the secret to use when pulling the image from a private registry
# pullSecret is the secret to use when pulling the image from a private registry
pullSecret:
# pullPolicy is either IfNotPresent or Always (https://kubernetes.io/docs/concepts/containers/images/)
pullPolicy: IfNotPresent
Expand Down Expand Up @@ -48,4 +48,6 @@ queueManager:
# name allows you to specify the name to use for the queue manager. Defaults to the Helm release name.
name:
# nameOverride can be set to partially override the name of the resources created by this chart
nameOverride:
nameOverride:
# livenessDelay should be raised if your system cannot start the Queue Manager in 60 seconds
livenessDelay: 60
37 changes: 21 additions & 16 deletions charts/mq-devserver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,26 +37,31 @@ The command removes all the Kubernetes components associated with the chart, exc

```bash
kubectl delete pvc -l release=foo
```
```

## Configuration
The following table lists the configurable parameters of the `mq-advancedserver` chart and their default values.

| Parameter | Description | Default |
| ---------------------------- | --------------------------------------------- | ---------------------------------------------------------- |
| `license` | Set to `accept` to accept the terms of the IBM license | `not accepted` |
| `image.name` | Image name | `ibmcom/mq` |
| `image.tag` | Image tag | `9` |
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
| `image.pullSecret` | Image pull secret, if you are using a private Docker registry | `nil` |
| `data.persistence.enabled` | Use a PersistentVolume to persist MQ data (under `/var/mqm`) | `true` |
| `data.persistence.storageClass` | Storage class of backing Persistent Volume | `nil` |
| `data.persistence.size` | Size of data volume | `2Gi` |
| `service.name` | Name of the Kubernetes service to create | `qmgr` |
| `service.type` | Kubernetes service type exposing ports, e.g. `NodePort` | `ClusterIP` |
| `queueManager.name` | MQ Queue Manager name | Helm release name |
| Parameter | Description | Default |
| -------------------------------- | ----------------------------------------------- | ---------------------------------------------------------- |
| `license` | Set to `accept` to accept the terms of the IBM license | `not accepted` |
| `image.repository` | Image full name including repository | `ibmcom/mq` |
| `image.tag` | Image tag | `9` |
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
| `image.pullSecret` | Image pull secret, if you are using a private Docker registry | `nil` |
| `data.persistence.enabled` | Use a PersistentVolume to persist MQ data (under `/var/mqm`) | `true` |
| `data.persistence.storageClass` | Storage class of backing Persistent Volume | `nil` |
| `data.persistence.size` | Size of data volume | `2Gi` |
| `service.name` | Name of the Kubernetes service to create | `qmgr` |
| `service.type` | Kubernetes service type exposing ports, e.g. `NodePort` | `ClusterIP` |
| `resources.limits.cpu` | Kubernetes CPU limit for the Queue Manager container | `500m` |
| `resources.limits.memory` | Kubernetes memory limit for the Queue Manager container | `512Mi` |
| `resources.requests.cpu` | Kubernetes CPU request for the Queue Manager container | `500m` |
| `resources.requests.memory` | Kubernetes memory request for the Queue Manager container | `512Mi` |
| `queueManager.name` | MQ Queue Manager name | Helm release name |
| `queueManager.dev.adminPassword` | Developer defaults - administrator password | Random generated string. See the notes that appear when you install for how to retrieve this. |
| `queueManager.dev.appPassword` | Developer defaults - app password | `nil` (no password required to connect an MQ client) |
| `queueManager.dev.appPassword` | Developer defaults - app password | `nil` (no password required to connect an MQ client) |
| `nameOverride` | Set to partially override the resource names used in this chart | `nil` |

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.

Expand All @@ -70,4 +75,4 @@ The chart mounts a [Persistent Volume](http://kubernetes.io/docs/user-guide/pers

# Copyright

© Copyright IBM Corporation 2017
© Copyright IBM Corporation 2017