RobertIndie commented on code in PR #1809:
URL: https://github.com/apache/streampipes/pull/1809#discussion_r1283323554
##########
installer/k8s/README.md:
##########
@@ -82,6 +82,160 @@ We retain the created persistent volume. You need to
manually delete it:
```bash
rm -rf ${HOME}/streampipes-k8s
```
+##Parameters
+
+###Common parameters
+| Parameter Name | Description
| Value |
+|--------------------------------------------------|---------------------------------------------------------|-----------------------------------------|
+| deployment | Deployment type (lite or
full) | lite |
+| preferredBroker | Preferred broker for
deployment | "nats" |
+| pullPolicy | Image pull policy
| "Always" |
+| restartPolicy | Restart policy for the
container | Always |
+| persistentVolumeReclaimPolicy | Reclaim policy for
persistent volumes | "Delete" |
+| persistentVolumeAccessModes | Access mode for
persistent volumes | "ReadWriteOnce"
|
+| initialDelaySeconds | Initial delay for
liveness and readiness probes | 60
|
+| periodSeconds | Interval between liveness
and readiness probes | 30 |
+| failureThreshold | Number of consecutive
failures for readiness probes | 30 |
+| hostPath | Host path for the
application | ""
|
+
+###Streampipes common parameters
+| Parameter Name | Description
| Value |
+|-------------------------------------------------|---------------------------------------------------------|------------------------------------------|
+| streampipes.version | StreamPipes version
| "0.93.0-SNAPSHOT" |
+| streampipes.registry | StreamPipes registry URL
| "apachestreampipes" |
+| streampipes.core.appName | StreamPipes backend
application name | "backend" |
+| streampipes.core.port | StreamPipes backend port
| 8030 |
+| streampipes.core.persistence.storageClassName | Storage class name for
backend PVs | "hostpath" |
+| streampipes.core.persistence.storageSize | Size of the backend PV
| "1Gi" |
+| streampipes.core.persistence.claimName | Name of the backend
PersistentVolumeClaim | "backend-pvc" |
+| streampipes.core.persistence.pvName | Name of the backend
PersistentVolume | "backend-pv" |
+| streampipes.core.service.name | Name of the backend
service | "backend" |
+| streampipes.core.service.port | Port for the backend
service | 8030 |
+| streampipes.ui.appName | StreamPipes UI application
name | "ui" |
+| streampipes.ui.resolverActive | Flag for enabling DNS
resolver for Nginx proxy | true |
+| streampipes.ui.port | StreamPipes UI port
| 8088 |
+| streampipes.ui.resolver | DNS resolver for Nginx
proxy | "kube-dns.kube-system.svc.cluster.local" |
+| streampipes.ui.service.name | Name of the UI service
| "ui" |
+| streampipes.ui.service.type | Type of the UI service
| "ClusterIP" |
+| streampipes.ui.service.nodePort | Node port for the UI
service | 8088 |
+| streampipes.ui.service.port | Port for the UI service
| 8088 |
+| streampipes.ingress.active | Flag for enabling Ingress
for StreamPipes | false |
+| streampipes.ingress.annotations | Annotations for Ingress
| {} |
+| streampipes.ingress.host | Hostname for Ingress
| "" |
+| streampipes.ingressroute.active | Flag for enabling
IngressRoute for StreamPipes | true
|
+| streampipes.ingressroute.annotations | Annotations for
IngressRoute | {}
|
+| streampipes.ingressroute.entryPoints | Entry points for
IngressRoute | ["web", "websecure"]
|
+| streampipes.ingressroute.host | Hostname for IngressRoute
| "" |
+| streampipes.ingressroute.certResolverActive | Flag for enabling
certificate resolver for IngressRoute | true
|
+| streampipes.ingressroute.certResolver | Certificate resolver for
IngressRoute | "" |
+
+
+###Extensions common parameters
+| Parameter Name | Description
| Value |
+|-------------------------------------------------|---------------------------------------------------------|------------------------------------------|
+| extensions.iiot.appName | IIoT extensions
application name | extensions-all-iiot
|
+| extensions.iiot.port | Port for the IIoT
extensions application | 8090
|
+| extensions.iiot.service.name | Name of the IIoT
extensions service | extensions-all-iiot1
|
+| extensions.iiot.service.port | Port for the IIoT
extensions service | 8090
|
+
+
+###External common parameters
+
+####Consul common parameters
+| Parameter Name | Description
| Value |
+|-------------------------------------------------|----------------------------------------------------------|-----------------|
+| external.consul.appName | Consul application name
| "consul" |
+| external.consul.version | Consul version
| 1.14.3 |
+| external.consul.port1 | Port 1 for Consul service
| 8500 |
+| external.consul.port2 | Port 2 for Consul service
| 8600 |
+| external.consul.persistence.storageClassName | Storage class name for
Consul PVs | "hostpath" |
+| external.consul.persistence.storageSize | Size of the Consul PV
| "1Gi" |
+| external.consul.persistence.claimName | Name of the Consul
PersistentVolumeClaim | "consul-pvc"
|
+| external.consul.persistence.pvName | Name of the Consul
PersistentVolume | "consul-pv"
|
+| external.consul.service.name | Name of the Consul service
| "consul" |
+| external.consul.service.port1 | Port 1 for the Consul
service | 8500 |
+| external.consul.service.port2 | Port 2 for the Consul
service | 8600 |
+
+####Couchdb common parameters
+| Parameter Name | Description
| Value |
+|-------------------------------------------------|----------------------------------------------------------|-----------------|
+| external.couchdb.appName | CouchDB application name
| "couchdb" |
+| external.couchdb.version | CouchDB version
| 3.3.1 |
+| external.couchdb.user | CouchDB admin username
| "admin" |
+| external.couchdb.password | CouchDB admin password
| "admin" |
+| external.couchdb.port | Port for the CouchDB
service | 5984 |
+| external.couchdb.service.name | Name of the CouchDB
service | "couchdb"
|
+| external.couchdb.service.port | Port for the CouchDB
service | 5984 |
+| external.couchdb.persistence.storageClassName | Storage class name for
CouchDB PVs | "hostpath" |
+| external.couchdb.persistence.storageSize | Size of the CouchDB PV
| "1Gi" |
+| external.couchdb.persistence.claimName | Name of the CouchDB
PersistentVolumeClaim | "couchdb-pvc"
|
+| external.couchdb.persistence.pvName | Name of the CouchDB
PersistentVolume | "couchdb-pv"
|
+
+####Influxdb common parameters
+| Parameter Name | Description
| Value |
+|-------------------------------------------------|----------------------------------------------------------|-----------------|
+| external.influxdb.appName | InfluxDB application name
| "influxdb" |
+| external.influxdb.version | InfluxDB version
| 2.6 |
+| external.influxdb.username | InfluxDB admin username
| "admin" |
+| external.influxdb.password | InfluxDB admin password
| "sp-admin" |
+| external.influxdb.adminToken | InfluxDB admin token
| "sp-admin" |
+| external.influxdb.initOrg | InfluxDB initial
organization | "sp"
|
+| external.influxdb.initBucket | InfluxDB initial bucket
| "sp" |
+| external.influxdb.initMode | InfluxDB initialization
mode | "setup" |
+| external.influxdb.port1 | Port 1 for the InfluxDB
service | 8083 |
+| external.influxdb.port2 | Port 2 for the InfluxDB
service | 8086 |
+| external.influxdb.port3 | Port 3 for the InfluxDB
service | 8090 |
+| external.influxdb.service.name | Name of the InfluxDB
service | "influxdb" |
+| external.influxdb.service.port1 | Port 1 for the InfluxDB
service | 8083 |
+| external.influxdb.service.port2 | Port 2 for the InfluxDB
service | 8086 |
+| external.influxdb.service.port3 | Port 3 for the InfluxDB
service | 8090 |
Review Comment:
It's better to give a more meaningful name for them.
##########
installer/k8s/README.md:
##########
@@ -82,6 +82,160 @@ We retain the created persistent volume. You need to
manually delete it:
```bash
rm -rf ${HOME}/streampipes-k8s
```
+##Parameters
+
+###Common parameters
+| Parameter Name | Description
| Value |
+|--------------------------------------------------|---------------------------------------------------------|-----------------------------------------|
+| deployment | Deployment type (lite or
full) | lite |
+| preferredBroker | Preferred broker for
deployment | "nats" |
+| pullPolicy | Image pull policy
| "Always" |
+| restartPolicy | Restart policy for the
container | Always |
+| persistentVolumeReclaimPolicy | Reclaim policy for
persistent volumes | "Delete" |
+| persistentVolumeAccessModes | Access mode for
persistent volumes | "ReadWriteOnce"
|
+| initialDelaySeconds | Initial delay for
liveness and readiness probes | 60
|
+| periodSeconds | Interval between liveness
and readiness probes | 30 |
+| failureThreshold | Number of consecutive
failures for readiness probes | 30 |
+| hostPath | Host path for the
application | ""
|
+
+###Streampipes common parameters
+| Parameter Name | Description
| Value |
+|-------------------------------------------------|---------------------------------------------------------|------------------------------------------|
+| streampipes.version | StreamPipes version
| "0.93.0-SNAPSHOT" |
+| streampipes.registry | StreamPipes registry URL
| "apachestreampipes" |
+| streampipes.core.appName | StreamPipes backend
application name | "backend" |
+| streampipes.core.port | StreamPipes backend port
| 8030 |
+| streampipes.core.persistence.storageClassName | Storage class name for
backend PVs | "hostpath" |
+| streampipes.core.persistence.storageSize | Size of the backend PV
| "1Gi" |
+| streampipes.core.persistence.claimName | Name of the backend
PersistentVolumeClaim | "backend-pvc" |
+| streampipes.core.persistence.pvName | Name of the backend
PersistentVolume | "backend-pv" |
+| streampipes.core.service.name | Name of the backend
service | "backend" |
+| streampipes.core.service.port | Port for the backend
service | 8030 |
+| streampipes.ui.appName | StreamPipes UI application
name | "ui" |
+| streampipes.ui.resolverActive | Flag for enabling DNS
resolver for Nginx proxy | true |
+| streampipes.ui.port | StreamPipes UI port
| 8088 |
+| streampipes.ui.resolver | DNS resolver for Nginx
proxy | "kube-dns.kube-system.svc.cluster.local" |
+| streampipes.ui.service.name | Name of the UI service
| "ui" |
+| streampipes.ui.service.type | Type of the UI service
| "ClusterIP" |
+| streampipes.ui.service.nodePort | Node port for the UI
service | 8088 |
+| streampipes.ui.service.port | Port for the UI service
| 8088 |
+| streampipes.ingress.active | Flag for enabling Ingress
for StreamPipes | false |
+| streampipes.ingress.annotations | Annotations for Ingress
| {} |
+| streampipes.ingress.host | Hostname for Ingress
| "" |
+| streampipes.ingressroute.active | Flag for enabling
IngressRoute for StreamPipes | true
|
+| streampipes.ingressroute.annotations | Annotations for
IngressRoute | {}
|
+| streampipes.ingressroute.entryPoints | Entry points for
IngressRoute | ["web", "websecure"]
|
+| streampipes.ingressroute.host | Hostname for IngressRoute
| "" |
+| streampipes.ingressroute.certResolverActive | Flag for enabling
certificate resolver for IngressRoute | true
|
+| streampipes.ingressroute.certResolver | Certificate resolver for
IngressRoute | "" |
+
+
+###Extensions common parameters
+| Parameter Name | Description
| Value |
+|-------------------------------------------------|---------------------------------------------------------|------------------------------------------|
+| extensions.iiot.appName | IIoT extensions
application name | extensions-all-iiot
|
+| extensions.iiot.port | Port for the IIoT
extensions application | 8090
|
+| extensions.iiot.service.name | Name of the IIoT
extensions service | extensions-all-iiot1
|
Review Comment:
Why is there a suffix 1 here? `extensions-all-iiot1`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
