grpl CRDs Documentation – 0.2.8
- 1. Introduction
- 2. gras – 0.2.8
- 2.1. gras.spec.autoscaling
- 2.2. gras.spec.grapis
- 2.3. gras.spec.grapis.spec
- 2.4. gras.spec.gruims
- 2.5. gras.spec.gruims.spec
- 2.6. gras.spec.resources
- 2.7. gras.spec.resources.deployimages
- 2.8. gras.spec.resources.deployimages.spec
- 2.9. gras.spec.resources.runimages
- 2.10. gras.spec.resources.runimages.spec
- 3. grapi – 0.2.8
- 3.1. grapi.spec.auth
- 3.2. grapi.spec.auth.basic
- 3.3. grapi.spec.auth.profile
- 3.4. grapi.spec.autoscaling
- 3.5. grapi.spec.cacheconfigs
- 3.6. grapi.spec.cacheconfigs.spec
- 3.7. grapi.spec.controllers
- 3.8. grapi.spec.controllers.spec
- 3.9. grapi.spec.datasources
- 3.10. grapi.spec.datasources.spec
- 3.11. grapi.spec.datasources.spec.kv-memory
- 3.12. grapi.spec.datasources.spec.kv-redis
- 3.13. grapi.spec.datasources.spec.memory
- 3.14. grapi.spec.datasources.spec.mysql
- 3.15. grapi.spec.datasources.spec.postgresql
- 3.16. grapi.spec.discoveries
- 3.17. grapi.spec.discoveries.spec
- 3.18. grapi.spec.externalsecrets
- 3.19. grapi.spec.externalsecrets.spec
- 3.20. grapi.spec.fuzzysearch
- 3.21. grapi.spec.fuzzysearch.spec
- 3.22. grapi.spec.initContainers
- 3.23. grapi.spec.initContainers.spec
- 3.24. grapi.spec.models
- 3.25. grapi.spec.models.spec
- 3.26. grapi.spec.models.spec.properties
- 3.27. grapi.spec.openapis
- 3.28. grapi.spec.openapis.spec
- 3.29. grapi.spec.postpatches
- 3.30. grapi.spec.prediscoverypatches
- 3.31. grapi.spec.prepatches
- 3.32. grapi.spec.prerelationpatches
- 3.33. grapi.spec.relations
- 3.34. grapi.spec.relations.spec
- 3.35. grapi.spec.repositories
- 3.36. grapi.spec.repositories.spec
- 3.37. grapi.spec.resources
- 3.38. grapi.spec.resources.deployimages
- 3.39. grapi.spec.resources.deployimages.spec
- 3.40. grapi.spec.resources.runimages
- 3.41. grapi.spec.resources.runimages.spec
- 3.42. grapi.spec.restcruds
- 3.43. grapi.spec.restcruds.spec
- 3.44. grapi.spec.serviceproviders
- 3.45. grapi.spec.serviceproviders.spec
- 3.46. grapi.spec.services
- 3.47. grapi.spec.services.spec
- 3.48. grapi.spec.volumeMounts
- 3.49. grapi.spec.volumes
- 4. gruim – 0.2.8
1. Introduction
the grapple CRDs
2. gras – 0.2.8
GROUP: grsf.grpl.io
KIND: GrappleApplicationSet
VERSION: v1alpha1
DESCRIPTION:
Specification of the desired behavior of the grapple ApplicationSet (gras).
gras.spec is the specification of the desired behavior of the
ApplicationSet.
FIELDS:
asname <string>
This field can be used to tweak the name of the parent gras (grapple
ApplicationSet).
It is optional and shall only be used if required.
(Default: "")
autoscaling <Object>
Please define here the scaling definitions for this gras (grapple
ApplicationSet)
enum: Background, Foreground
<no description>
enum: Automatic, Manual
<no description>
customheader <string>
Please specify here the custom header content protecting the gras (grapple
ApplicationSet)
(Default: "")
dev <boolean>
Please specify here if the DEV mode shall be activated for the whole gras
(grapple ApplicationSet)
(Default: false)
grapis <[]Object>
Please add here the grapis (grapple APIs)
for this gras (grapple ApplicationSet)
grasversion <string>
Please specify here the version of the gras (grapple ApplicationSet)
gruims <[]Object>
Please add here the gruims (grapple UI modules)
for this gras (grapple ApplicationSet)
name <string>
This field can be used to tweak the name of the gras.
It is optional and shall only be used if required.
Default: ""
resources <Object>
Please add here the resource definitions for this gras (grapple
ApplicationSet)
2.1. gras.spec.autoscaling
GROUP: grsf.grpl.io
KIND: GrappleApplicationSet
VERSION: v1alpha1
DESCRIPTION:
Please define here the scaling definitions for this gras (grapple
ApplicationSet)
FIELDS:
maxReplicas <integer>
Please specify the maximum number of replicas for the resources in this gras
(grapple ApplicationSet)
Default: 20
minReplicas <integer>
Please specify the minimum number of replicas for the resources in this gras
(grapple ApplicationSet)
Default: 1
replicas <integer>
Please specify the number of replicas for the resources in this gras
(grapple ApplicationSet)
Default: 1
targetCPUUtilizationPercentage <integer>
Please specify the targetCPUUtilizationPercentage for the resources in this
gras (grapple ApplicationSet)
Default: 60
2.2. gras.spec.grapis
GROUP: grsf.grpl.io
KIND: GrappleApplicationSet
VERSION: v1alpha1
DESCRIPTION:
Please add here the grapis (grapple APIs)
for this gras (grapple ApplicationSet)
FIELDS:
name <string>
please specify the name for the grapi (grapple API)
spec <Object>
please specify the spec for the grapi (grapple API)
verify against "kubectl explain grapi.spec"
2.3. gras.spec.grapis.spec
GROUP: grsf.grpl.io
KIND: GrappleApplicationSet
VERSION: v1alpha1
DESCRIPTION:
please specify the spec for the grapi (grapple API)
verify against "kubectl explain grapi.spec"
2.4. gras.spec.gruims
GROUP: grsf.grpl.io
KIND: GrappleApplicationSet
VERSION: v1alpha1
DESCRIPTION:
Please add here the gruims (grapple UI modules)
for this gras (grapple ApplicationSet)
FIELDS:
name <string>
please specify the name for the gruim (grapple UI module)
spec <Object>
please specify the spec for the gruim (grapple UI module)
verify against "kubectl explain gruim.spec"
2.5. gras.spec.gruims.spec
GROUP: grsf.grpl.io
KIND: GrappleApplicationSet
VERSION: v1alpha1
DESCRIPTION:
please specify the spec for the gruim (grapple UI module)
verify against "kubectl explain gruim.spec"
2.6. gras.spec.resources
GROUP: grsf.grpl.io
KIND: GrappleApplicationSet
VERSION: v1alpha1
DESCRIPTION:
Please add here the resource definitions for this gras (grapple
ApplicationSet)
FIELDS:
deployimages <Object>
Please specify the resource definitions for the resources in this gras
(grapple ApplicationSet) in deployimages mode
deployimages mode deploys the pre-baked images requires therefore less
resources
runimages <Object>
Please specify the resource definitions for the resources in this gras
(grapple ApplicationSet) in runimages mode
runimages mode builds the deployment and requires more resources
2.7. gras.spec.resources.deployimages
GROUP: grsf.grpl.io
KIND: GrappleApplicationSet
VERSION: v1alpha1
DESCRIPTION:
Please specify the resource definitions for the resources in this gras
(grapple ApplicationSet) in deployimages mode
deployimages mode deploys the pre-baked images requires therefore less
resources
FIELDS:
spec <Object>
Please specify resource definitions for the resources in this gras (grapple
ApplicationSet) in deployimages mode
verify against "kubectl explain pod.spec.containers.resources"
example/default:
resources:
requests:
memory: "256Mi"
cpu: "250m"
limits:
# when changing memory here, please consider also chaning
max_old_space_size in env of be deployment.
memory: "1024Mi"
cpu: "2000m"
2.8. gras.spec.resources.deployimages.spec
GROUP: grsf.grpl.io
KIND: GrappleApplicationSet
VERSION: v1alpha1
DESCRIPTION:
Please specify resource definitions for the resources in this gras (grapple
ApplicationSet) in deployimages mode
verify against "kubectl explain pod.spec.containers.resources"
example/default:
resources:
requests:
memory: "256Mi"
cpu: "250m"
limits:
# when changing memory here, please consider also chaning
max_old_space_size in env of be deployment.
memory: "1024Mi"
cpu: "2000m"
2.9. gras.spec.resources.runimages
GROUP: grsf.grpl.io
KIND: GrappleApplicationSet
VERSION: v1alpha1
DESCRIPTION:
Please specify the resource definitions for the resources in this gras
(grapple ApplicationSet) in runimages mode
runimages mode builds the deployment and requires more resources
FIELDS:
spec <Object>
Please specify resource definitions for the resources in this gras (grapple
ApplicationSet) in runimages mode
verify against "kubectl explain pod.spec.containers.resources"
example/default:
resources:
requests:
memory: "256Mi"
cpu: "250m"
limits:
# when changing memory here, please consider also chaning
max_old_space_size in env of be deployment.
memory: "2Gi"
cpu: "3000m"
2.10. gras.spec.resources.runimages.spec
GROUP: grsf.grpl.io
KIND: GrappleApplicationSet
VERSION: v1alpha1
DESCRIPTION:
Please specify resource definitions for the resources in this gras (grapple
ApplicationSet) in runimages mode
verify against "kubectl explain pod.spec.containers.resources"
example/default:
resources:
requests:
memory: "256Mi"
cpu: "250m"
limits:
# when changing memory here, please consider also chaning
max_old_space_size in env of be deployment.
memory: "2Gi"
cpu: "3000m"
3. grapi – 0.2.8
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Specification of the desired behavior of the grapple API (grapi). grapi.spec
is the specification of the desired behavior of the grapple API.
FIELDS:
asname <string>
This field can be used to tweak the name of the parent gras (grapple
ApplicationSet).
It is optional and shall only be used if required.
(Default: "")
auth <Object>
Please define here the authenticatino settings for this grapi (grapple API)
automigrate <boolean>
Please specify whether to automatically migrate the datasource in this grapi
(grapple API)?
runs: "npm run migrate"
further information:
https://loopback.io/doc/en/lb4/Database-migrations.html
autorestartgruim <boolean>
auto-restart the gruim (grapple UI module) on a change in the grapi (grapple
API) spec
using a kubernetes cronjob?
(Default: false)
autoscaling <Object>
Please define here the scaling definitions for this grapi (grapple API)
beimage <string>
Please specify here the image repository for the grapi (grapple API) base
image
(Default: "grpl/grapi")
beimagetag <string>
Please specify here the image tag for the grapi (grapple API) base image.
(Default: "0.2.8")
buildimagecache <boolean>
Shall a cache be used for building the images for this grapi (grapple API)?
(Default: false)
This feature is currently still under development
buildimages <boolean>
Shall images be built (pre-baked) for this grapi (grapple API)?
(Default: false)
This feature is currently still under development
cacheconfigs <[]Object>
Please add here all the cache configurations that shall be deployed within
this grapi (grapple API)
clusterdomain <string>
Please specify here the clusterdomain of the target cluster.
only use this field if not specified in the grapple config or the gras
(grapple ApplicationSet).
(Default: "" - usually defined in the grapple config secret)
enum: Background, Foreground
<no description>
enum: Automatic, Manual
<no description>
controllers <[]Object>
Please add here all the controllers that shall be generated within this
grapi (grapple API)
further information:
https://loopback.io/doc/en/lb4/Controller-generator.html
corsurls <string>
Please specify here the allowed cors urls for protecting the grapi (grapple
API)
(e.g. "http://localhost:3000,http://localhost:2000")
(Default: "")
customheader <string>
Please specify here the custom header content protecting the grapi (grapple
API)
This value can be used to override the header specified in the gras (grapple
ApplicationSet).
(Default: "")
datasources <[]Object>
Please add here all the datasources that shall be deployed within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/DataSource-generator.html
deployimages <boolean>
Shall the (pre-baked) images be deployed?
Please make sure, an "imagetag" is specified
(Default: false)
This feature is currently still under development
dev <boolean>
Please specify here if the DEV mode shall be activated for this grapi
(grapple API)
this value can be used to override the header specified in the gras.
(Default: false)
disableexplorer <boolean>
Please specify "true" if you want to disable the explorer of the the grapi
(grapple API) deployment
(Default: false)
discoveredrepos <boolean>
Please specify whether to automatically discover the repositories for the
models in this grapi (grapple API)?
(Default: true)
discoveries <[]Object>
Please add here all the discoveries that shall be executed within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/Discovering-models.html
email <string>
This field can be used to define the email address displayed in the
microservice.
This value may be derived from the cluster config.
(Default: "info@grapple-solutions.com")
externalsecrets <[]Object>
Please add here the externalsecrets for this grapi (grapple API)
you can attach multiple externalsecrets specifications to your grapi
(grapple API)
all variables in the secret become available to the grapi (grapple API):
https://external-secrets.io/
example:
externalsecrets:
- name: classicmodelsas-auroramysql
spec:
refreshInterval: 1h
secretStoreRef:
name: aws-secretstore
kind: ClusterSecretStore
target:
name: mytarget
creationPolicy: Owner
dataFrom:
- extract:
key: "mysecret"
extraSecrets <[]string>
Please add here the extraSecrets for this grapi (grapple API)
you can just reference the name of a secret and all parameters
become available inside the grapi (grapple API) deployment as variables
fuzzysearch <[]Object>
Please add here all the fuzzy search configurations that shall be generated
within this grapi (grapple API)
graphql <boolean>
Please specify whether to deploy a graphql interface for the grapi (grapple
API)?
(Default: false)
grapiversion <string>
Please specify here the version of grapple API (grapi)
imagetag <string>
Please specify here the imagetag for the grapi (grapple API) image that
shall be deployed
(Default: "")
This feature is currently still under development
ingress <boolean>
Please specify here if ingress shall be enabled for the grapi (grapple API
service)
(Default: true)
initContainers <[]Object>
specify initContainers that shall run successfully before starting the grapi
(grapple API)
example:
initContainers:
- name: init-db
spec:
command:
- bash
- -c
- sleep 5; COMMAND_TO_EXECUTE
image: mysql
name: init-db
models <[]Object>
Please add here all the models that shall be deployed within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/Model-generator.html
monitoring <boolean>
Please specify whether the extended monitoring endpoint should be enabled
for this grapi (grapple API)?
(Default: true)
name <string>
This field can be used to tweak the name of the grapi.
It is optional and shall only be used if required.
(Default: "")
openapis <[]Object>
Please add here all the openapis that shall be deployed within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/OpenAPI-generator.html
organization <string>
This field can be used to define the organization name displayed in the
microservice.
This value may be derived from the cluster config.
(Default: "grapple solutions")
postpatches <[]Object>
Please add here a patch script (base64 encoded) that shall run after backend
creation
within this grapi (grapple API)
prediscoverypatches <[]Object>
Please add here a patch script (base64 encoded) that shall run before the
discovery
after datasource creation within this grapi (grapple API)
prepatches <[]Object>
Please add here a patch script (base64 encoded) that shall run before
datasource creation
within this grapi (grapple API)
prerelationpatches <[]Object>
Please add here a patch script (base64 encoded) that shall run before the
creation of relations
within this grapi (grapple API)
relations <[]Object>
Please add here all the relations that shall be deployed within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/Relation-generator.html
repositories <[]Object>
Please add here all the repositories that shall be generated within this
grapi (grapple API)
further information:
https://loopback.io/doc/en/lb4/Repository-generator.html
resources <Object>
Please add here the resource definitions for this grapi (grapple API)
resourcesNpmMem <string>
Please specify here the allowed memory to be used by the nodejs processes
(Default: 1152)
restcruds <[]Object>
Please add here all the restcruds that shall be generated within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/Rest-Crud-generator.html
runimages <boolean>
Shall the images for this grapi (grapple API) be run directly?
(Default: true)
serviceproviders <[]Object>
Please add here all the serviceproviders that shall be deployed within this
grapi (grapple API)
further information:
https://loopback.io/doc/en/lb4/Service-generator.html
services <[]Object>
Please add here all the services that shall be generated within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/Service-generator.html
ssl <boolean>
Please specify here if ssl shall be configured for the grapi (grapple API
ingress)
(Default: false)
sslissuer <string>
Please specify here the ssl issuer for the grapi (grapple API ingress)
(Default: "")
volumeMounts <[]Object>
specify volumeMounts that shall be mounted to the grapi (grapple API)
verify against:
kubectl explain pod.spec.containers.volumeMounts
volumes <[]Object>
Specify additional volumes that shall be attached to the grapi (grapple API)
verify against:
kubectl explain pod.spec.volumes
3.1. grapi.spec.auth
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please define here the authenticatino settings for this grapi (grapple API)
FIELDS:
basic <Object>
Please define here the basic authenticatino settings for this grapi (grapple
API)
LICENSE: Starter
profile <Object>
Please define here the basic authenticatino settings for this grapi (grapple
API)
LICENSE: Pro
(TODO: NOT YET IMPLEMENTED)
3.2. grapi.spec.auth.basic
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please define here the basic authenticatino settings for this grapi (grapple
API)
LICENSE: Starter
FIELDS:
config <string>
Please specify here if basic authentication config for the grapi (grapple
API)
Example: '{"auth": true, "writeonly": true, "exclude": "/invoices"}'
Requires ENV "Users" to exist - use "auth.basic.secretName" to create Users
LICENSE: Starter
secretName <string>
Please specify here secret containing basic authentication credentials for
this grapi (grapple API)
Example: mysecret
Example: kubectl create secret generic authusers --from-literal
Users='[{"username": "grapple", "email": "info@grapple-solutions.com",
"password": "mysecretpw", "realm": "random"}, {"username": "sales", "email":
"sales@grapple-solutions.com", "password": "mysalespw", "realm": "random"}]'
LICENSE: Starter
3.3. grapi.spec.auth.profile
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please define here the basic authenticatino settings for this grapi (grapple
API)
LICENSE: Pro
(TODO: NOT YET IMPLEMENTED)
FIELDS:
profile <string>
Please define here the authentication profile for this grapi (grapple API)
LICENSE: Pro
(TODO: NOT YET IMPLEMENTED)
settings <string>
Please define here the authentication profile settings for this grapi
(grapple API)
LICENSE: Pro
(TODO: NOT YET IMPLEMENTED)
3.4. grapi.spec.autoscaling
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please define here the scaling definitions for this grapi (grapple API)
FIELDS:
maxReplicas <integer>
Please specify the maximum number of replicas for the resources in this
grapi (grapple API)
Default: 20
minReplicas <integer>
Please specify the minimum number of replicas for the resources in this
grapi (grapple API)
Default: 1
replicas <integer>
Please specify the number of replicas for the resources in this grapi
(grapple API)
Default: 1
targetCPUUtilizationPercentage <integer>
Please specify the targetCPUUtilizationPercentage for the resources in this
grapi (grapple API)
Default: 60
3.5. grapi.spec.cacheconfigs
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here all the cache configurations that shall be deployed within
this grapi (grapple API)
FIELDS:
content <string>
please specify the content for the cache configuration in form of a json
string
example:
{"redisDS":"redisDS","cacheTTL":6000000,"openApis":"cm","exclude":"*:employees/*"}
or use the spec for yaml format
name <string>
please specify the name for the cache configuration
spec <Object>
<no description>
3.6. grapi.spec.cacheconfigs.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
<empty>
FIELDS:
cacheTTL <integer>
Please specify here the cache TTL for the cache storage in seconds
example:
60000
exclude <string>
Please specify here, which endpoints shall be excluded from the cache
example:
*:employees/*
include <string>
Please specify here, which endpoints shall be included in the cache
example:
*:customers/*
if specified, everything else is excluded.
openApis <string>
Please specify here the name of the openapi specification that shall be
cached
Only specify a reference to the name of the openapi resource in the grapi
(grapple API)
redisDS <string>
Please specify here the name of the cache datasource (kv-redis datasource)
to be used as cache storage
3.7. grapi.spec.controllers
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here all the controllers that shall be generated within this
grapi (grapple API)
further information:
https://loopback.io/doc/en/lb4/Controller-generator.html
FIELDS:
content <string>
please specify the content for the controller in form of a json string
example:
{"controllerType":"empty"}
or use the spec for yaml format
name <string>
please specify the name for the controller
spec <Object>
<no description>
3.8. grapi.spec.controllers.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
<empty>
FIELDS:
controllerType <string>
Type for the %s
3.9. grapi.spec.datasources
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here all the datasources that shall be deployed within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/DataSource-generator.html
FIELDS:
content <string>
please specify the content for the datasource in form of a json string
example:
{"name":"classicmodels","connector":"mysql","url":"","host":"DBHOST","port":"DBPORT","user":"DBUSER","password":"DBPW","database":"DBSCHEMA"}
or use the spec for yaml format
name <string>
please specify the name for the datasource
spec <Object>
<no description>
3.10. grapi.spec.datasources.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
<empty>
FIELDS:
kv-memory <Object>
Please specify the specs for datasource type kv-memory
kv-redis <Object>
Please specify the specs for datasource type kv-redis
memory <Object>
Please specify the specs for datasource type memory
mysql <Object>
Please specify the specs for datasource type mysql
postgresql <Object>
Please specify the specs for datasource type postgresql
3.11. grapi.spec.datasources.spec.kv-memory
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please specify the specs for datasource type kv-memory
FIELDS:
connector <string>
Please provide the connector type for the datasource - Default: kv-memory
name <string>
Please provide a name for the datasource
3.12. grapi.spec.datasources.spec.kv-redis
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please specify the specs for datasource type kv-redis
FIELDS:
connector <string>
Please provide the connector type for the datasource - Default: kv-redis
db <string>
Spec for db for datasource kv-redis
host <string>
Spec for host for datasource kv-redis
name <string>
Please provide a name for the datasource
password <string>
Spec for password for datasource kv-redis
port <string>
Spec for port for datasource kv-redis
url <string>
Spec for url for datasource kv-redis
3.13. grapi.spec.datasources.spec.memory
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please specify the specs for datasource type memory
FIELDS:
connector <string>
Please provide the connector type for the datasource - Default: memory
file <string>
Spec for file for datasource memory
localStorage <string>
Spec for localStorage for datasource memory
name <string>
Please provide a name for the datasource
3.14. grapi.spec.datasources.spec.mysql
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please specify the specs for datasource type mysql
FIELDS:
connector <string>
Please provide the connector type for the datasource - Default: mysql
database <string>
Spec for database for datasource mysql
host <string>
Spec for host for datasource mysql
name <string>
Please provide a name for the datasource
password <string>
Spec for password for datasource mysql
port <string>
Spec for port for datasource mysql
url <string>
Spec for url for datasource mysql
user <string>
Spec for user for datasource mysql
3.15. grapi.spec.datasources.spec.postgresql
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please specify the specs for datasource type postgresql
FIELDS:
connector <string>
Please provide the connector type for the datasource - Default: postgresql
database <string>
Spec for database for datasource postgresql
host <string>
Spec for host for datasource postgresql
name <string>
Please provide a name for the datasource
password <string>
Spec for password for datasource postgresql
port <string>
Spec for port for datasource postgresql
url <string>
Spec for url for datasource postgresql
user <string>
Spec for user for datasource postgresql
3.16. grapi.spec.discoveries
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here all the discoveries that shall be executed within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/Discovering-models.html
FIELDS:
content <string>
please specify the content for the discovery in form of a json string
example:
{"dataSource":"classicmodels","schema":"DBSCHEMA","all":"true","disableCamelCase":false,"yes":"undefined"}
or use the spec for yaml format
name <string>
please specify the name for the discovery
spec <Object>
<no description>
3.17. grapi.spec.discoveries.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
<empty>
FIELDS:
all <boolean>
Discover all models without prompting users to select
dataSource <string>
The name of the datasource to discover
disableCamelCase <boolean>
disableCamelCase
models <string>
Discover specific models without prompting users to select
e.g:--models=table1,table2
optionalId <boolean>
Boolean to mark id property as optional field
outDir <string>
Specify the directory into which the `model.model.ts` files will be placed
relations <boolean>
Discover and create relations
schema <string>
Schema to discover
views <boolean>
Boolean to discover views
3.18. grapi.spec.externalsecrets
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here the externalsecrets for this grapi (grapple API)
you can attach multiple externalsecrets specifications to your grapi
(grapple API)
all variables in the secret become available to the grapi (grapple API):
https://external-secrets.io/
example:
externalsecrets:
- name: classicmodelsas-auroramysql
spec:
refreshInterval: 1h
secretStoreRef:
name: aws-secretstore
kind: ClusterSecretStore
target:
name: mytarget
creationPolicy: Owner
dataFrom:
- extract:
key: "mysecret"
FIELDS:
name <string>
please specify the name for the externalsecrets object
spec <Object>
Please specify the spec for the externalsecrets
verify against:
kubectl explain externalsecrets.spec
https://external-secrets.io/
3.19. grapi.spec.externalsecrets.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please specify the spec for the externalsecrets
verify against:
kubectl explain externalsecrets.spec
https://external-secrets.io/
3.20. grapi.spec.fuzzysearch
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here all the fuzzy search configurations that shall be generated
within this grapi (grapple API)
FIELDS:
content <string>
please specify the content for the fuzzy search configuration in form of a
json string
example:
{"fuzzy":true,"centralFuzzy":true,"datasource":"classicmodels","appName":"Grpl","exclude":"employees"}
or use the spec for yaml format
name <string>
please specify the name for the fuzzy search configuration
spec <Object>
<no description>
3.21. grapi.spec.fuzzysearch.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
<empty>
FIELDS:
appName <string>
Please specify here the application name for the fuzzy endpoint
centralFuzzy <boolean>
Please specify here if a central fuzzy endpoint over all endpoints shall be
made available
datasource <string>
Please specify here the name of the datasource for which
the fuzzy search endpoint shall be generated
Specify only the name of the datasource as a reference
exclude <string>
Please specify here excludes for the fuzzy endpoint
example:
*:employees/*
fuzzy <boolean>
Please specify here if a fuzzy search should be made available for each
endpoint
include <string>
Please specify here includes for the fuzzy endpoint
example:
*:customers/*
3.22. grapi.spec.initContainers
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
specify initContainers that shall run successfully before starting the grapi
(grapple API)
example:
initContainers:
- name: init-db
spec:
command:
- bash
- -c
- sleep 5; COMMAND_TO_EXECUTE
image: mysql
name: init-db
FIELDS:
name <string>
please specify the name for the initContainer
spec <Object>
please specify the spec for the grapi (grapple API) initContainer
verify against:
kubectl explain pod.spec.initContainers
3.23. grapi.spec.initContainers.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
please specify the spec for the grapi (grapple API) initContainer
verify against:
kubectl explain pod.spec.initContainers
3.24. grapi.spec.models
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here all the models that shall be deployed within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/Model-generator.html
FIELDS:
content <string>
please specify the content for the models in form of a json string
example:
{"base":"Entity","name":"customer","properties":{"id":{"type":"number","id":true,"required":true,"generated":true},"customername":{"type":"string"},"emaildomain":{"type":"string","required":true},"datecreated":{"type":"date","required":false},"datelastupdated":{"type":"date","required":false}}}
or use the spec for yaml format
name <string>
please specify the name for the model
spec <Object>
<no description>
3.25. grapi.spec.models.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
<empty>
FIELDS:
base <string>
A valid based model
dataSource <string>
The name of the dataSource which contains this model and suppots model
discovery
name <string>
name
properties <map[string]Object>
properties
schema <string>
If discovering a model from a dataSource, specify the schema which contains
it
table <string>
If discovering a model from a dataSource, specify the name of its table/view
3.26. grapi.spec.models.spec.properties
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
properties
FIELDS:
default <string>
Please define the default value for the field (e.g. 'myvalue')
defaultFn <string>
Please define the default function for the field (e.g. 'uuid' (for ID string
fields), 'now' (for date fields))
generated <boolean>
Please define, if the field is autogenerated by the underlying system (e.g.
database) (boolean, e.g. true / false) (false, if defaultFn is defined)
id <boolean>
Please define if the field is an ID (unique identifier for this model)
itemType <string>
Please define the type of the item if type = array (e.g. 'string', 'number')
length <string>
Please define the length of the field (e.g. 20 (for 20 characters))
required <boolean>
Please define whether the field is required (boolean, e.g. true / false) (if
the field is generated, it is NOT required)
type <string>
Please define the type of the field (e.g. 'string', 'array', 'number')
3.27. grapi.spec.openapis
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here all the openapis that shall be deployed within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/OpenAPI-generator.html
FIELDS:
content <string>
please specify the content for the openapi in form of a json string
example:
{"prefix":"cm","url":"URL_TO_OPENAPI_SPEC","client":true}
or use the spec for yaml format
name <string>
please specify the name for the openapi
spec <Object>
<no description>
3.28. grapi.spec.openapis.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
<empty>
FIELDS:
baseModel <string>
Base model class
client <boolean>
Generate client-side service proxies for the OpenAPI spec
datasource <string>
A valid datasource name for the OpenAPI endpoint
prefix <string>
Provide prefix to avoid duplication
promote-anonymous-schemas <boolean>
Promote anonymous schemas as models
readonly <string>
Only include endpoints with provided regex.
server <boolean>
Generate server-side controllers for the OpenAPI spec
url <string>
URL or file path of the OpenAPI spec
validate <boolean>
Validate the OpenAPI spec
3.29. grapi.spec.postpatches
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here a patch script (base64 encoded) that shall run after backend
creation
within this grapi (grapple API)
FIELDS:
content <string>
please specify the content for the patch script
(base64 encoded string)
example:
bnBtIGkgdXVpZAo=
name <string>
please specify the name for the patch script
3.30. grapi.spec.prediscoverypatches
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here a patch script (base64 encoded) that shall run before the
discovery
after datasource creation within this grapi (grapple API)
FIELDS:
content <string>
please specify the content for the patch script
(base64 encoded string)
example:
bnBtIGkgdXVpZAo=
name <string>
please specify the name for the patch script
3.31. grapi.spec.prepatches
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here a patch script (base64 encoded) that shall run before
datasource creation
within this grapi (grapple API)
FIELDS:
content <string>
please specify the content for the patch script
(base64 encoded string)
example:
bnBtIGkgdXVpZAo=
name <string>
please specify the name for the patch script
3.32. grapi.spec.prerelationpatches
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here a patch script (base64 encoded) that shall run before the
creation of relations
within this grapi (grapple API)
FIELDS:
content <string>
please specify the content for the patch script
(base64 encoded string)
example:
bnBtIGkgdXVpZAo=
name <string>
please specify the name for the patch script
3.33. grapi.spec.relations
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here all the relations that shall be deployed within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/Relation-generator.html
FIELDS:
content <string>
please specify the content for the relation in form of a json string
example:
{"destinationModel":"Employees","foreignKeyName":"employeesId","registerInclusionResolver":true,"relationName":"employees","relationType":"belongsTo","sourceModel":"Customers"}
or use the spec for yaml format
name <string>
please specify the name for the relation
spec <Object>
<no description>
3.34. grapi.spec.relations.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
<empty>
FIELDS:
customReferenceKeys <string>
Destination model key
defaultForeignKeyName <string>
default foreign key name
defaultRelationName <string>
Default relation name
destinationModel <string>
Destination model key
destinationModelPrimaryKey <string>
Primary key on destination model
destinationModelPrimaryKeyType <string>
Type of the primary key on destination model
foreignKeyName <string>
Destination model foreign key name (optional, provide only when there is a
custom foreign key)
registerInclusionResolver <boolean>
Allow <sourceModel> queries to include data from related <destinationModel>
relationName <string>
Relation name
relationType <string>
Relation type
sourceKeyOnThrough <string>
Foreign key references source model on through model
sourceModel <string>
Source model
sourceModelPrimaryKey <string>
Primary key on source model
sourceModelPrimaryKeyType <string>
Type of the primary key on source model
targetKeyOnThrough <string>
Foreign key references target model on through model
throughModel <string>
Through model
3.35. grapi.spec.repositories
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here all the repositories that shall be generated within this
grapi (grapple API)
further information:
https://loopback.io/doc/en/lb4/Repository-generator.html
FIELDS:
content <string>
please specify the content for the repository in form of a json string
example:
{"name": "repositoryNameToBeGenerated","datasource":
"validDataSourceName","model": "validDModelName","id":
"anOptionalNameForID","repositoryBaseClass": "validRepositoryBaseClass"}
or use the spec for yaml format
name <string>
please specify the name for the repository
spec <Object>
<no description>
3.36. grapi.spec.repositories.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
<empty>
FIELDS:
datasource <string>
A valid datasource name
id <string>
A valid ID property name for the specified model
model <string>
A valid model name
repositoryBaseClass <string>
A valid repository base class
3.37. grapi.spec.resources
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here the resource definitions for this grapi (grapple API)
FIELDS:
deployimages <Object>
Please specify the resource definitions for the resources in this grapi
(grapple API) in deployimages mode
deployimages mode deploys the pre-baked images requires therefore less
resources
runimages <Object>
Please specify the resource definitions for the resources in this grapi
(grapple API) in runimages mode
runimages mode builds the deployment and requires more resources
3.38. grapi.spec.resources.deployimages
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please specify the resource definitions for the resources in this grapi
(grapple API) in deployimages mode
deployimages mode deploys the pre-baked images requires therefore less
resources
FIELDS:
spec <Object>
Please specify resource definitions for the resources in this grapi (grapple
API) in deployimages mode
verify against "kubectl explain pod.spec.containers.resources"
example/default:
resources:
requests:
memory: "256Mi"
cpu: "250m"
limits:
# when changing memory here, please consider also chaning
max_old_space_size in env of be deployment.
memory: "1024Mi"
cpu: "2000m"
3.39. grapi.spec.resources.deployimages.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please specify resource definitions for the resources in this grapi (grapple
API) in deployimages mode
verify against "kubectl explain pod.spec.containers.resources"
example/default:
resources:
requests:
memory: "256Mi"
cpu: "250m"
limits:
# when changing memory here, please consider also chaning
max_old_space_size in env of be deployment.
memory: "1024Mi"
cpu: "2000m"
3.40. grapi.spec.resources.runimages
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please specify the resource definitions for the resources in this grapi
(grapple API) in runimages mode
runimages mode builds the deployment and requires more resources
FIELDS:
spec <Object>
Please specify resource definitions for the resources in this grapi (grapple
API) in runimages mode
verify against "kubectl explain pod.spec.containers.resources"
example/default:
resources:
requests:
memory: "256Mi"
limits:
# when changing memory here, please consider also chaning
max_old_space_size in env of be deployment.
memory: "2Gi"
cpu: "3000m"
3.41. grapi.spec.resources.runimages.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please specify resource definitions for the resources in this grapi (grapple
API) in runimages mode
verify against "kubectl explain pod.spec.containers.resources"
example/default:
resources:
requests:
memory: "256Mi"
limits:
# when changing memory here, please consider also chaning
max_old_space_size in env of be deployment.
memory: "2Gi"
cpu: "3000m"
3.42. grapi.spec.restcruds
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here all the restcruds that shall be generated within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/Rest-Crud-generator.html
FIELDS:
content <string>
please specify the content for the restcrud in form of a json string
example:
{"datasource":"classicmodels"}
or use the spec for yaml format
name <string>
please specify the name for the restcrud
spec <Object>
<no description>
3.43. grapi.spec.restcruds.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
<empty>
FIELDS:
basePath <string>
A valid base path
datasource <string>
A valid datasource name
model <string>
A valid model name
readonly <boolean>
Create readonly APIs
3.44. grapi.spec.serviceproviders
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here all the serviceproviders that shall be deployed within this
grapi (grapple API)
further information:
https://loopback.io/doc/en/lb4/Service-generator.html
FIELDS:
content <string>
please specify the content for the service in form of a json string
example:
{"name": "serviceNameToBeGenerated","datasource": "validDataSourceName"}
or use the spec for yaml format
name <string>
please specify the name for the service
spec <Object>
<no description>
3.45. grapi.spec.serviceproviders.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
<empty>
FIELDS:
serviceprovidersproperty <string>
serviceprovidersproperty
3.46. grapi.spec.services
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Please add here all the services that shall be generated within this grapi
(grapple API)
further information:
https://loopback.io/doc/en/lb4/Service-generator.html
FIELDS:
content <string>
please specify the content for the service in form of a json string
example:
{"name":"serviceNameToBeGenerated","datasource":"validDataSourceName"}
or use the spec for yaml format
name <string>
please specify the name for the service
spec <Object>
<no description>
3.47. grapi.spec.services.spec
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
<empty>
FIELDS:
datasource <string>
A valid datasource name
type <string>
Service type - proxy, class or provider
3.48. grapi.spec.volumeMounts
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
specify volumeMounts that shall be mounted to the grapi (grapple API)
verify against:
kubectl explain pod.spec.containers.volumeMounts
please specify the spec for the grapi (grapple API) volumeMounts
verify against:
kubectl explain pod.spec.containers.volumeMounts
3.49. grapi.spec.volumes
GROUP: grsf.grpl.io
KIND: GrappleApi
VERSION: v1alpha1
DESCRIPTION:
Specify additional volumes that shall be attached to the grapi (grapple API)
verify against:
kubectl explain pod.spec.volumes
please specify the spec for the grapi (grapple API) volumes
verify against:
kubectl explain pod.spec.volumes
4. gruim – 0.2.8
GROUP: grsf.grpl.io
KIND: GrappleUiModule
VERSION: v1alpha1
DESCRIPTION:
Specification of the desired behavior of the gruim (grapple UI modules).
gruim.spec is the specification of the desired behavior of the grapple UI
modules.
FIELDS:
additionalpackages <string>
Please specify here the additional npm packages
that need to be installed for the gruim (grapple UI modules)
example:
svelte-fullcalendar@2.0.0-beta.0 @fullcalendar/common@5.10.1
@fullcalendar/core@5.10.1 @fullcalendar/daygrid@5.10.1
@fullcalendar/interaction@5.10.1 @fullcalendar/timegrid@5.10.1 dayjs@1.11.2
(Default: "")
asname <string>
This field can be used to tweak the name of the parent gras (grapple
ApplicationSet). It is optional and shall only be used if required.
(Default: "")
autoscaling <Object>
Please define here the scaling definitions for this gruim (grapple UI
module)
buildimagecache <boolean>
Shall a cache be used for building the images for this gruim (grapple UI
modules)?
(Default: false)
This feature is currently still under development
buildimages <boolean>
Shall images be built (pre-baked) for this gruim (grapple UI modules)
(Default: false)
This feature is currently still under development
clusterdomain <string>
Please specify here the clusterdomain of the target cluster.
only use this field if not specified in the grapple config or the gras
(grapple ApplicationSet).
(Default: "" - usually defined in the grapple config secret)
enum: Background, Foreground
<no description>
enum: Automatic, Manual
<no description>
config <string>
Please configure here the appearance of the gruim (grapple UI modules)
This will amend the appearance of the UI modules.
TODO: add link to the documentation on grapple-solutions.com
Documentation:
https://${NS}-${GRASNAME}-gruim.${DOMAIN}/documentation/
example:
{"global":{"list-size":10,"field-properties":{"id":{"readonly":false}},"weekStart":
1},"schema":{"Trainer":{"field-order":["id","vorname","name","email","aktiv","SummerRateBefore","SummerRateAfter","WinterRateBefore","WinterRateAfter","ClubRate","notizen","token"]},"Kunde":{"field-order":["id","bexioId","name","vorname","mail","ort","plz","strasse","land"]},"Gruppe":{"field-order":["id","gruppenname","beschreibung","gruppentyp","notizen"]},"Product":{"field-order":["id","bexioId","interncode","internname","interndescription","saleprice","taxid","articlegroupid"]},"Rapport":{"field-order":["id","datum","invoicedIn","trainer","kunde","gruppe","platz","startzeit","trainingsdauer","trainingType","nachholtermin","probetraining","archived","notizen"]}}}
(Default: "")
customheader <string>
Please specify here the custom header content protecting the gruim (grapple
UI modules)
This value can be used to override the header specified in the gras (grapple
ApplicationSet).
(Default: "")
custommodules <[]Object>
'Please add here base64 encoded custom modules that shall be injected into'
Please specify here the additional npm packages
that need to be installed for the gruim (grapple UI modules)
deployimages <boolean>
Shall the (pre-baked) images be deployed?
Please make sure, an "imagetag" is specified
(Default: false)
This feature is currently still under development
dev <boolean>
Please specify here if the DEV mode shall be activated for this gruim
(grapple UI modules)
this value can be used to override the header specified in the gras.
(Default: false)
endpoint <string>
Please specify here the url of the openapi endpoint
that serves API reqeusts for the gruim (grapple UI modules)
This field is usually filled automatically by the gras (grapple
ApplicationSet)
But can be overwritten/adjusted here
gruimversion <string>
Please specify here the version of gruim (grapple UI modules)
imagetag <string>
Please specify here the imagetag for the gruim (grapple UI modules) image
that shall be deployed
(Default: "")
This feature is currently still under development
ingress <boolean>
Please specify here if ingress shall be enabled for the gruim (grapple UI
modules service)
(Default: true)
mapi <string>
Please specify here the name of the mapi (kubectl get mapi (in the same
namespace))
that contains definitions for the API behind the gruim (grapple UI modules)
This field is usually filled automatically by the gras (grapple
ApplicationSet)
But can be overwritten/adjusted here
monitoring <boolean>
Please specify whether the extended monitoring endpoint should be enabled
for this gruim (grapple UI modules)?
(Default: true)
name <string>
This field can be used to tweak the name of the gruim (grapple UI modules).
It is optional and shall only be used if required.
(Default: "")
openapi <string>
Please specify here the url of the openapi specification
that contains definitions for the API behind the gruim (grapple UI modules)
This field is usually filled automatically by the gras (grapple
ApplicationSet)
But can be overwritten/adjusted here
resources <Object>
Please add here the resource definitions for this gruim (grapple UI modules)
runimages <boolean>
Shall the images for this gruim (grapple UI modules) be run directly?
(Default: true)
ssl <boolean>
Please specify here if ssl shall be configured for the gruim (grapple UI
modules ingress)
(Default: false)
sslissuer <string>
Please specify here the ssl issuer for the gruim (grapple UI modules)
(Default: "")
style <string>
Please specify here the style for the gruim (grapple UI modules)
The style is defined in a tailwind CSS styling format
https://tailwindcss.com/
example:
{"colors":{"primary":{"DEFAULT":"#ff7300","fg":"#fff"},"accent":{"DEFAULT":"#808080","fg":"#fff"}}}
uiimage <string>
Please specify here the image repository for the gruim (grapple UI modules)
base image
(Default: "grpl/gruim")
uiimagetag <string>
Please specify here the image tag for the gruim (grapple UI modules) base
image.
(Default: "0.2.8")
uimodules <boolean>
Please specify whether to deploy the gruim (grapple UI modules)
or only the grapi (grapple API)
(Default: true)
4.1. gruim.spec.autoscaling
GROUP: grsf.grpl.io
KIND: GrappleUiModule
VERSION: v1alpha1
DESCRIPTION:
Please define here the scaling definitions for this gruim (grapple UI
module)
FIELDS:
maxReplicas <integer>
Please specify the maximum number of replicas for the resources in this
gruim (grapple UI module)
Default: 20
minReplicas <integer>
Please specify the minimum number of replicas for the resources in this
gruim (grapple UI module)
Default: 1
replicas <integer>
Please specify the number of replicas for the resources in this gruim
(grapple UI module)
Default: 1
targetCPUUtilizationPercentage <integer>
Please specify the targetCPUUtilizationPercentage for the resources in this
gruim (grapple UI module)
Default: 60
4.2. gruim.spec.custommodules
GROUP: grsf.grpl.io
KIND: GrappleUiModule
VERSION: v1alpha1
DESCRIPTION:
'Please add here base64 encoded custom modules that shall be injected into'
Please specify here the additional npm packages
that need to be installed for the gruim (grapple UI modules)
FIELDS:
content <string>
Please specify the content/code for the custom UI modules injection
in the gruim (grapple UI modules)
(base64 encoded string)
example:
TODO: add a simple example for a module injection
name <string>
please specify the name for the custom UI modules in the gruim (grapple UI
modules)
4.3. gruim.spec.resources
GROUP: grsf.grpl.io
KIND: GrappleUiModule
VERSION: v1alpha1
DESCRIPTION:
Please add here the resource definitions for this gruim (grapple UI modules)
FIELDS:
deployimages <Object>
Please specify the resource definitions for the resources in this gruim
(grapple UI modules) in deployimages mode
deployimages mode deploys the pre-baked images requires therefore less
resources
runimages <Object>
Please specify the resource definitions for the resources in this gruim
(grapple UI modules) in runimages mode
runimages mode builds the deployment and requires more resources
4.4. gruim.spec.resources.deployimages
GROUP: grsf.grpl.io
KIND: GrappleUiModule
VERSION: v1alpha1
DESCRIPTION:
Please specify the resource definitions for the resources in this gruim
(grapple UI modules) in deployimages mode
deployimages mode deploys the pre-baked images requires therefore less
resources
FIELDS:
spec <Object>
Please specify resource definitions for the resources in this gruim (grapple
UI modules) in deployimages mode
verify against "kubectl explain pod.spec.containers.resources"
example/default:
resources:
requests:
memory: "256Mi"
cpu: "250m"
limits:
# when changing memory here, please consider also chaning
max_old_space_size in env of be deployment.
memory: "1024Mi"
cpu: "2000m"
4.5. gruim.spec.resources.deployimages.spec
GROUP: grsf.grpl.io
KIND: GrappleUiModule
VERSION: v1alpha1
DESCRIPTION:
Please specify resource definitions for the resources in this gruim (grapple
UI modules) in deployimages mode
verify against "kubectl explain pod.spec.containers.resources"
example/default:
resources:
requests:
memory: "256Mi"
cpu: "250m"
limits:
# when changing memory here, please consider also chaning
max_old_space_size in env of be deployment.
memory: "1024Mi"
cpu: "2000m"
4.6. gruim.spec.resources.runimages
GROUP: grsf.grpl.io
KIND: GrappleUiModule
VERSION: v1alpha1
DESCRIPTION:
Please specify the resource definitions for the resources in this gruim
(grapple UI modules) in runimages mode
runimages mode builds the deployment and requires more resources
FIELDS:
spec <Object>
Please specify resource definitions for the resources in this gruim (grapple
UI modules) in runimages mode
verify against "kubectl explain pod.spec.containers.resources"
example/default:
resources:
requests:
memory: "256Mi"
limits:
# when changing memory here, please consider also chaning
max_old_space_size in env of be deployment.
memory: "2Gi"
cpu: "3000m"
4.7. gruim.spec.resources.runimages.spec
GROUP: grsf.grpl.io
KIND: GrappleUiModule
VERSION: v1alpha1
DESCRIPTION:
Please specify resource definitions for the resources in this gruim (grapple
UI modules) in runimages mode
verify against "kubectl explain pod.spec.containers.resources"
example/default:
resources:
requests:
memory: "256Mi"
limits:
# when changing memory here, please consider also chaning
max_old_space_size in env of be deployment.
memory: "2Gi"
cpu: "3000m"