Skip to content

Commit

Permalink
docs: fix some names
Browse files Browse the repository at this point in the history
  • Loading branch information
@philipsens
philipsens committed Aug 23, 2024
1 parent dd0ecf4 commit 108b28d
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 77 deletions.
66 changes: 32 additions & 34 deletions charts/frank-console/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# 🔌Frank!Framework Chart
# 🔌Frank!Framework Console Chart

This Helm Chart can be used for running the Frank!Framework on Kubernetes.

The image should be replaced to include a configuration.
The Frank!Framework console is a web application that allows you to manage multiple instances of Frank!Framework from a single console.

## Usage

Expand All @@ -22,13 +20,13 @@ frankframework` to see the charts.
To install the frankframework chart:

```shell
helm install my-frankframework frankframework/frankframework
helm install my-frank-console frankframework/frank-console
```

To uninstall the chart:

```shell
helm delete my-frankframework
helm delete my-frank-console
```

## Parameters
Expand All @@ -40,29 +38,29 @@ helm delete my-frankframework
| `nameOverride` | String to partially override fullname template (will maintain the release name) | `""` |
| `fullnameOverride` | String to fully override fullname template | `""` |

### Frank!Framework image parameters
### frank-console image parameters

The image is pulled from nexus.frankframework.org by default. The images located there will be kept for as long as possible.
Here are the images available:
https://nexus.frankframework.org/#browse/browse:frankframework-docker:v2%2Ffrankframework%2Ftags/
If you want to use a specific nightly, you can use the images on docker.io:
https://hub.docker.com/r/frankframework/frankframework/tags

| Name | Description | Value |
| ------------------- | ---------------------------------------------------------- | -------------------------- |
| `image.registry` | Frank!Framework image registry | `nexus.frankframework.org` |
| `image.repository` | Frank!Framework image repository | `frank-console` |
| `image.tag` | Frank!Framework image tag (immutable tags are recommended) | `""` |
| `image.pullPolicy` | Frank!Framework image pull policy | `IfNotPresent` |
| `image.pullSecrets` | Frank!Framework image pull secrets | `[]` |
| Name | Description | Value |
| ------------------- | -------------------------------------------------------- | -------------------------- |
| `image.registry` | frank-console image registry | `nexus.frankframework.org` |
| `image.repository` | frank-console image repository | `frank-console` |
| `image.tag` | frank-console image tag (immutable tags are recommended) | `""` |
| `image.pullPolicy` | frank-console image pull policy | `IfNotPresent` |
| `image.pullSecrets` | frank-console image pull secrets | `[]` |

### Frank!Framework application parameters
### frank-console application parameters

| Name | Description | Value |
| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `application.memory.percentage` | Set if the values for the memory are in percentages | `false` |
| `application.memory.minimum` | Sets the initial size of the heap that will be used by the Frank!Framework | `1G` |
| `application.memory.maximum` | Sets the maximum size of the heap that will be used by the Frank!Framework | `1G` |
| `application.memory.minimum` | Sets the initial size of the heap that will be used by the frank-console | `1G` |
| `application.memory.maximum` | Sets the maximum size of the heap that will be used by the frank-console | `1G` |
| `application.security.http.authentication` | Set http authentication for the Frank! | `false` |
| `application.security.http.localUsers` | Set localUsers who can log in on the Frank! | `[]` |
| `application.security.http.localUsers` | Note: If kept empty no localUsers.yml will be generated, this can be used if the application already has a localUsers.yml | |
Expand All @@ -79,22 +77,22 @@ https://hub.docker.com/r/frankframework/frankframework/tags
| `application.security.http.activeDirectory.roleMapping.observer` | Map the role for Observer | `""` |
| `application.javaOpts` | Append custom options to the `JAVA_OPTS` environment variable for the Frank! | `""` |

### Frank!Framework deployment parameters
### frank-console deployment parameters

The startup probe will enable blue-green deployment, which are great for uptime during upgrades and such.
It (and the liveness probe) will check if the console is accessible, until a better health endpoint is available.
The readiness probe will check if all adapters are running using the server health endpoint

| Name | Description | Value |
| ------------------------------- | -------------------------------------------------------- | ----------- |
| `replicaCount` | Number of Frank!Framework replicas to deploy | `1` |
| `replicaCount` | Number of frank-console replicas to deploy | `1` |
| `startupProbe` | Configure the startup probe | `{}` |
| `livenessProbe` | Configure the liveness probe | `{}` |
| `readinessProbe` | Configure the readiness probe | `{}` |
| `resources` | Set the resources for the Frank!Framework containers | `{}` |
| `resources.limits` | The resources limits for the Frank!Framework containers | `undefined` |
| `resources.requests.memory` | The requested memory for the Frank!Framework containers | `undefined` |
| `resources.requests.cpu` | The requested cpu for the Frank!Framework containers | `undefined` |
| `resources` | Set the resources for the frank-console containers | `{}` |
| `resources.limits` | The resources limits for the frank-console containers | `undefined` |
| `resources.requests.memory` | The requested memory for the frank-console containers | `undefined` |
| `resources.requests.cpu` | The requested cpu for the frank-console containers | `undefined` |
| `terminationGracePeriodSeconds` | Number of seconds after which pods are forcefully killed | `60` |
| `terminationGracePeriodSeconds` | Note: Lower values may cause running adapters to fail | |
| `nodeSelector` | Node labels for pod assignment | `{}` |
Expand All @@ -106,8 +104,8 @@ The readiness probe will check if all adapters are running using the server heal

| Name | Description | Value |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `service.type` | Frank!Framework service type | `ClusterIP` |
| `service.port` | Frank!Framework service port | `80` |
| `service.type` | frank-console service type | `ClusterIP` |
| `service.port` | frank-console service port | `80` |
| `ingress.enabled` | Enable ingress record generation for Frank! | `false` |
| `ingress.className` | IngressClass that will be used to implement the Ingress (Kubernetes 1.18+) | `""` |
| `ingress.annotations` | Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations. | `{}` |
Expand All @@ -120,15 +118,15 @@ The readiness probe will check if all adapters are running using the server heal

### Other Parameters

| Name | Description | Value |
| ---------------------------- | --------------------------------------------------------- | ------ |
| `serviceAccount.create` | Enable creation of ServiceAccount for Frank!Framework pod | `true` |
| `serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` |
| `serviceAccount.name` | The name of the ServiceAccount to use. | `""` |
| `podAnnotations` | Annotations for Frank!Framework pods | `{}` |
| `podLabels` | Extra labels for Frank!Framework pods | `{}` |
| `podSecurityContext` | Set Frank!Framework pod's Security Context | `{}` |
| `securityContext` | Set Frank!Framework container's Security Context | `{}` |
| Name | Description | Value |
| ---------------------------- | ------------------------------------------------------- | ------ |
| `serviceAccount.create` | Enable creation of ServiceAccount for frank-console pod | `true` |
| `serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` |
| `serviceAccount.name` | The name of the ServiceAccount to use. | `""` |
| `podAnnotations` | Annotations for frank-console pods | `{}` |
| `podLabels` | Extra labels for frank-console pods | `{}` |
| `podSecurityContext` | Set frank-console pod's Security Context | `{}` |
| `securityContext` | Set frank-console container's Security Context | `{}` |

## Configuration and installation details

Expand Down
26 changes: 13 additions & 13 deletions charts/frank-console/values.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,27 @@
"properties": {
"registry": {
"type": "string",
"description": "Frank!Framework image registry",
"description": "frank-console image registry",
"default": "nexus.frankframework.org"
},
"repository": {
"type": "string",
"description": "Frank!Framework image repository",
"description": "frank-console image repository",
"default": "frank-console"
},
"tag": {
"type": "string",
"description": "Frank!Framework image tag (immutable tags are recommended)",
"description": "frank-console image tag (immutable tags are recommended)",
"default": ""
},
"pullPolicy": {
"type": "string",
"description": "Frank!Framework image pull policy",
"description": "frank-console image pull policy",
"default": "IfNotPresent"
},
"pullSecrets": {
"type": "array",
"description": "Frank!Framework image pull secrets",
"description": "frank-console image pull secrets",
"default": [],
"items": {}
}
Expand All @@ -56,12 +56,12 @@
},
"minimum": {
"type": "string",
"description": "Sets the initial size of the heap that will be used by the Frank!Framework",
"description": "Sets the initial size of the heap that will be used by the frank-console",
"default": "1G"
},
"maximum": {
"type": "string",
"description": "Sets the maximum size of the heap that will be used by the Frank!Framework",
"description": "Sets the maximum size of the heap that will be used by the frank-console",
"default": "1G"
}
}
Expand Down Expand Up @@ -148,7 +148,7 @@
},
"replicaCount": {
"type": "number",
"description": "Number of Frank!Framework replicas to deploy",
"description": "Number of frank-console replicas to deploy",
"default": 1
},
"startupProbe": {
Expand Down Expand Up @@ -197,12 +197,12 @@
"properties": {
"type": {
"type": "string",
"description": "Frank!Framework service type",
"description": "frank-console service type",
"default": "ClusterIP"
},
"port": {
"type": "number",
"description": "Frank!Framework service port",
"description": "frank-console service port",
"default": 80
}
}
Expand Down Expand Up @@ -240,7 +240,7 @@
"properties": {
"create": {
"type": "boolean",
"description": "Enable creation of ServiceAccount for Frank!Framework pod",
"description": "Enable creation of ServiceAccount for frank-console pod",
"default": true
},
"annotations": {
Expand All @@ -257,12 +257,12 @@
},
"podAnnotations": {
"type": "object",
"description": "Annotations for Frank!Framework pods",
"description": "Annotations for frank-console pods",
"default": {}
},
"podLabels": {
"type": "object",
"description": "Extra labels for Frank!Framework pods",
"description": "Extra labels for frank-console pods",
"default": {}
}
}
Expand Down
Loading

0 comments on commit 108b28d

Please sign in to comment.