Skip to content

Commit

Permalink
Merge pull request #145 from Ontotext-AD/Release-GraphDB-10.8.0
Browse files Browse the repository at this point in the history
Release GraphDB 10.8.0
  • Loading branch information
Sukhumi authored Nov 12, 2024
2 parents 53fffa6 + 2bf19ac commit 2113990
Show file tree
Hide file tree
Showing 10 changed files with 54 additions and 52 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
- Added `license.optional` to configure the license volume as optional if needed
- Added `license.readOnly` to configure the read/write mode of the license volume mount

- Updated to GraphDB [10.8.0](https://graphdb.ontotext.com/documentation/10.8/release-notes.html#graphdb-10-8-0)

### Updated

- Removed any pre-install, pre-upgrade, pre-rollback Helm hooks annotations to allow seamless ArgoCD deployments.
Expand Down
4 changes: 2 additions & 2 deletions Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ apiVersion: v2
name: graphdb
description: GraphDB is a highly efficient, scalable and robust graph database with RDF and SPARQL support.
type: application
version: 11.2.2
appVersion: 10.7.6
version: 11.3.0
appVersion: 10.8.0
kubeVersion: ^1.26.0-0
home: https://graphdb.ontotext.com/
icon: https://graphdb.ontotext.com/home/images/visual_Logo_GraphDB_02_12_2015.png
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Helm Chart for GraphDB

[![CI](https://github.com/Ontotext-AD/graphdb-helm/actions/workflows/ci.yml/badge.svg)](https://github.com/Ontotext-AD/graphdb-helm/actions/workflows/ci.yml)
![Version: 11.2.2](https://img.shields.io/badge/Version-11.2.2-informational?style=flat-square)
![AppVersion: 10.7.6](https://img.shields.io/badge/AppVersion-10.7.6-informational?style=flat-square)
![Version: 11.3.0](https://img.shields.io/badge/Version-11.3.0-informational?style=flat-square)
![AppVersion: 10.8.0](https://img.shields.io/badge/AppVersion-10.8.0-informational?style=flat-square)

<!--
TODO: Add ArtifactHub badge when ready
Expand Down Expand Up @@ -196,7 +196,7 @@ Note: If `1` is selected as node count, the launched node will be standalone and

- The section `cluster.config` can be used to configure a GraphDB cluster.

See more about the cluster here: https://graphdb.ontotext.com/documentation/10.7/cluster-basics.html
See more about the cluster here: https://graphdb.ontotext.com/documentation/10.8/cluster-basics.html

### Deploying GraphDB with security

Expand All @@ -211,7 +211,7 @@ Note that the `provisioning` user is required when security is turned on!
By default, if the security is turned on, GraphDB's basic security method is used. More complicated security configurations
can be configured using additional configurations in `graphdb.properties`.
See https://graphdb.ontotext.com/documentation/10.7/access-control.html
See https://graphdb.ontotext.com/documentation/10.8/access-control.html
Prior to GraphDB 10.0.0 the users and their settings were saved in the `settings.js` file.
Expand All @@ -230,9 +230,9 @@ Note the `settings.js` must contain `security.enabled" : true` property when sec
GraphDB uses Logback to configure logging using the `logback.xml` file.
The file can be provisioned before GraphDB's startup with the `configuration.logback.existingConfigmap` configuration.
See https://graphdb.ontotext.com/documentation/10.7/directories-and-config-properties.html#configuration-properties
See https://graphdb.ontotext.com/documentation/10.8/directories-and-config-properties.html#configuration-properties
See https://graphdb.ontotext.com/documentation/10.7/access-control.html
See https://graphdb.ontotext.com/documentation/10.8/access-control.html
### Importing data from existing persistent volume
Expand Down
8 changes: 4 additions & 4 deletions README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ Note: If `1` is selected as node count, the launched node will be standalone and

- The section `cluster.config` can be used to configure a GraphDB cluster.

See more about the cluster here: https://graphdb.ontotext.com/documentation/10.7/cluster-basics.html
See more about the cluster here: https://graphdb.ontotext.com/documentation/10.8/cluster-basics.html

### Deploying GraphDB with security

Expand All @@ -211,7 +211,7 @@ Note that the `provisioning` user is required when security is turned on!
By default, if the security is turned on, GraphDB's basic security method is used. More complicated security configurations
can be configured using additional configurations in `graphdb.properties`.

See https://graphdb.ontotext.com/documentation/10.7/access-control.html
See https://graphdb.ontotext.com/documentation/10.8/access-control.html

Prior to GraphDB 10.0.0 the users and their settings were saved in the `settings.js` file.

Expand All @@ -230,9 +230,9 @@ Note the `settings.js` must contain `security.enabled" : true` property when sec
GraphDB uses Logback to configure logging using the `logback.xml` file.
The file can be provisioned before GraphDB's startup with the `configuration.logback.existingConfigmap` configuration.

See https://graphdb.ontotext.com/documentation/10.7/directories-and-config-properties.html#configuration-properties
See https://graphdb.ontotext.com/documentation/10.8/directories-and-config-properties.html#configuration-properties

See https://graphdb.ontotext.com/documentation/10.7/access-control.html
See https://graphdb.ontotext.com/documentation/10.8/access-control.html

### Importing data from existing persistent volume

Expand Down
2 changes: 1 addition & 1 deletion examples/aws/backup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@ backup:
existingSecret: graphdb-custom-backup-options
```

See https://graphdb.ontotext.com/documentation/10.7/backup-and-restore.html#backup-options for supported options.
See https://graphdb.ontotext.com/documentation/10.8/backup-and-restore.html#backup-options for supported options.
2 changes: 1 addition & 1 deletion examples/azure/backup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,4 @@ backup:
existingSecret: graphdb-custom-backup-options
```

See https://graphdb.ontotext.com/documentation/10.7/backup-and-restore.html#backup-options for supported options.
See https://graphdb.ontotext.com/documentation/10.8/backup-and-restore.html#backup-options for supported options.
34 changes: 17 additions & 17 deletions examples/configuring/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
Configuring GraphDB
===

This document provides detailed instructions on how to configure GraphDB,
including setting properties, secret properties, and additional configurations.
This document provides detailed instructions on how to configure GraphDB,
including setting properties, secret properties, and additional configurations.

It covers various methods to manage configuration options, such as using
ConfigMaps and Secrets, and highlights some good practices to ensure secure
and efficient setup. Additionally, it explains how to set Java arguments
It covers various methods to manage configuration options, such as using
ConfigMaps and Secrets, and highlights some good practices to ensure secure
and efficient setup. Additionally, it explains how to set Java arguments
and environment variables for GraphDB.

All GraphDB configuration options can be found
[here](https://graphdb.ontotext.com/documentation/10.7/directories-and-config-properties.html#general-properties).
All GraphDB configuration options can be found
[here](https://graphdb.ontotext.com/documentation/10.8/directories-and-config-properties.html#general-properties).

## Properties

This section is used to set GraphDB properties in the default ConfigMap for
This section is used to set GraphDB properties in the default ConfigMap for
graphdb.properties directly from the `values.yaml` file.
The configurations, typically including non-sensitive information such as product settings,
The configurations, typically including non-sensitive information such as product settings,
will be merged with the properties in the default ConfigMap.

```yaml
Expand All @@ -30,7 +30,7 @@ configuration:
## Secret Properties
This section is used to set default Secret properties directly from the `values.yaml` file.
The configurations, typically including sensitive information such as secret tokens (eg. OpenAI API tokens),
The configurations, typically including sensitive information such as secret tokens (eg. OpenAI API tokens),
will be merged with the properties in the default Secret.

```yaml
Expand All @@ -39,7 +39,7 @@ configuration:
graphdb.connector.keystorePass: "xxxx"
```

**Warning: This method of configuring GraphDB is strongly discouraged, as it may
**Warning: This method of configuring GraphDB is strongly discouraged, as it may
lead to secrets being exposed or stored insecurely!**

## Extra Properties
Expand Down Expand Up @@ -75,8 +75,8 @@ configuration:
## Java Arguments

This section explains how to set Java arguments for GraphDB using
the `values.yaml` file. The `configuration.javaArguments` field allows you to specify
Java Virtual Machine (JVM) options, such as memory settings, to optimize
the `values.yaml` file. The `configuration.javaArguments` field allows you to specify
Java Virtual Machine (JVM) options, such as memory settings, to optimize
the performance and resource usage of the GraphDB instance.

It also supports GraphDB properties in the form of `-Dproperty=value`
Expand All @@ -89,9 +89,9 @@ configuration:
## Extra Environment Variables from a source

This section explains how to configure GraphDB with environment variables
using an existing Kubernetes ConfigMap or an existing Secrets. This approach
ensures that additional configurations are injected alongside existing
ones without mixing different contexts.
using an existing Kubernetes ConfigMap or an existing Secrets. This approach
ensures that additional configurations are injected alongside existing
ones without mixing different contexts.

The resources referenced in this section can be found in the [resources.yaml](./resources.yaml) file.

Expand Down Expand Up @@ -120,4 +120,4 @@ The most recommended way of configuration GraphDB is by using existing resources
the sensitive information. In this cases `configuration.extraProperties` and `extraEnvFrom`
are most suitable for this.

For non-sensitive information any method of configuring GraphDB is viable.
For non-sensitive information any method of configuring GraphDB is viable.
2 changes: 1 addition & 1 deletion examples/plugins/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# GraphDB External Plugins Examples

This folder contains examples of how to configure GraphDB with external plugins by providing them to the classpath.
See https://graphdb.ontotext.com/documentation/10.7/plug-in-api.html#adding-external-plugins-to-graphdb for more information and
See https://graphdb.ontotext.com/documentation/10.8/plug-in-api.html#adding-external-plugins-to-graphdb for more information and
configuration examples.

## Using GraphDB Persistence
Expand Down
2 changes: 1 addition & 1 deletion examples/virtualization/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# GraphDB Virtualization Examples

This folder contains examples of how to configure GraphDB's virtualization features by providing JDBC drivers to GraphDB's classpath.
See https://graphdb.ontotext.com/documentation/10.7/virtualization.html for more information and [Ontop](https://ontop-vkg.org/guide/)
See https://graphdb.ontotext.com/documentation/10.8/virtualization.html for more information and [Ontop](https://ontop-vkg.org/guide/)
configuration examples.

## Using GraphDB Persistence
Expand Down
38 changes: 19 additions & 19 deletions values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ image:
# Set value to 1 to run a standalone GraphDB instance
# Set value to more than 1 to form a GraphDB cluster with GraphDB cluster proxies.
# This setting control the deployment of the cluster proxies and cluster jobs as well.
# Ref: https://graphdb.ontotext.com/documentation/10.7/creating-a-cluster.html
# Ref: https://graphdb.ontotext.com/documentation/10.8/creating-a-cluster.html
replicas: 1

##########################
Expand Down Expand Up @@ -142,7 +142,7 @@ license:
readOnly: true

# GraphDB runtime configuration settings.
# For reference, see https://graphdb.ontotext.com/documentation/10.7/directories-and-config-properties.html
# For reference, see https://graphdb.ontotext.com/documentation/10.8/directories-and-config-properties.html
configuration:
# The external URL at which GraphDB should be accessible.
# This can be a publicly available domain name, an internal one or even a Kubernetes service address.
Expand Down Expand Up @@ -201,7 +201,7 @@ configuration:
# GraphDB configuration properties can also be passed here in the format -Dproperty=value
# Takes precedence over any configurations provided in graphdb.properties
# The value is processed as a Helm template.
# Ref: https://graphdb.ontotext.com/documentation/10.7/directories-and-config-properties.html#configuration
# Ref: https://graphdb.ontotext.com/documentation/10.8/directories-and-config-properties.html#configuration
defaultJavaArguments: -XX:+UseContainerSupport -XX:MaxRAMPercentage=70 -XX:-UseCompressedOops -Ddefault.min.distinct.threshold=100m

# Java arguments to append after .Values.configuration.defaultJavaArguments
Expand All @@ -210,7 +210,7 @@ configuration:
javaArguments: ""

# Configurations for GraphDB's Logback
# Ref: https://graphdb.ontotext.com/documentation/10.7/diagnosing-and-reporting-critical-errors.html#logs
# Ref: https://graphdb.ontotext.com/documentation/10.8/diagnosing-and-reporting-critical-errors.html#logs
#
# Example:
# logback:
Expand Down Expand Up @@ -250,7 +250,7 @@ security:
# This setting controls the initial setup of the security and the provisioning of the default initial users.js and settings.js files from this chart.
# If the security has been enabled after the initial start, changing this flag won't provision anything in order to protect from overriding changes.
# This setting also controls the authentication in the cluster provisioning jobs.
# Ref: https://graphdb.ontotext.com/documentation/10.7/enabling-security.html
# Ref: https://graphdb.ontotext.com/documentation/10.8/enabling-security.html
enabled: false

# Administrator user with ROLE_ADMIN authority.
Expand Down Expand Up @@ -311,11 +311,11 @@ security:
##################################

# Configurations for creating and configuring the GraphDB cluster.
# Ref: https://graphdb.ontotext.com/documentation/10.7/creating-a-cluster.html
# Ref: https://graphdb.ontotext.com/documentation/10.8/creating-a-cluster.html
cluster:
# Configurations for shared token authentication in the cluster.
# The secret token is used to encrypt and decrypt the communication between GraphDB nodes in the cluster.
# Ref: https://graphdb.ontotext.com/documentation/10.7/creating-a-cluster.html#prerequisites
# Ref: https://graphdb.ontotext.com/documentation/10.8/creating-a-cluster.html#prerequisites
token:
# Defines the secret token as plaintext.
# Note: Consider providing an existing Secret object with the token via .Values.cluster.token.existingSecret
Expand All @@ -332,7 +332,7 @@ cluster:

# Cluster configuration parameters.
# Changing the parameters would trigger a Job that patches the configuration.
# Ref: https://graphdb.ontotext.com/documentation/10.7/creating-a-cluster.html#creation-parameters
# Ref: https://graphdb.ontotext.com/documentation/10.8/creating-a-cluster.html#creation-parameters
config:
# Reference to a ConfigMap with a custom JSON configuration to use when creating the cluster.
# This setting overrides any other values specified under .Values.cluster.config.params
Expand Down Expand Up @@ -566,7 +566,7 @@ tempVolume:
# Note that the CronJob will use the provisioner credentials from .Values.security.provisioner
# Note that the CronJob configurations are affected from the common settings in .Values.jobs
#
# Ref: https://graphdb.ontotext.com/documentation/10.7/backup-and-restore.html#creating-a-cloud-backup
# Ref: https://graphdb.ontotext.com/documentation/10.8/backup-and-restore.html#creating-a-cloud-backup
backup:

# Toggles the creation of the CronJob for scheduled GraphDB backups.
Expand All @@ -587,15 +587,15 @@ backup:
# Backup options that will be injected as JSON in the default backup options Secret. \
# These configurations define the backup behaviour such as including or excluding repositories or system data.
#
# Ref: https://graphdb.ontotext.com/documentation/10.7/backup-and-restore.html#backup-options
# Ref: https://graphdb.ontotext.com/documentation/10.8/backup-and-restore.html#backup-options
options:
backupSystemData: true

# GraphDB specific configuration options when creating backups.
# These options are not bound to the type of the backup (local or cloud).
# These will be projected in the default backup options Secret object as JSON.
#
# Ref: https://graphdb.ontotext.com/documentation/10.7/backup-and-restore.html#backup-options
# Ref: https://graphdb.ontotext.com/documentation/10.8/backup-and-restore.html#backup-options
optionsSecret:
# Reference to an existing Secret that contains the backup options.
# This overrides any value defined under .Values.backup.options
Expand Down Expand Up @@ -627,7 +627,7 @@ backup:
#
# Note: This won't be used if an existing secret has been provided with .Values.backup.optionsSecret.existingSecret
#
# Ref: https://graphdb.ontotext.com/documentation/10.7/backup-and-restore.html#creating-and-restoring-cloud-backups
# Ref: https://graphdb.ontotext.com/documentation/10.8/backup-and-restore.html#creating-and-restoring-cloud-backups
bucketUri: ""

# Configurations for a local GraphDB backup.
Expand Down Expand Up @@ -807,7 +807,7 @@ topologySpreadConstraints: []
##########################

# Resource configurations for the GraphDB containers.
# For resizing to your needs, refer to the GraphDB documentation https://graphdb.ontotext.com/documentation/10.7/requirements.html
# For resizing to your needs, refer to the GraphDB documentation https://graphdb.ontotext.com/documentation/10.8/requirements.html
# Ref: https://kubernetes.io/docs/tasks/configure-pod-container/assign-pods-nodes/
resources:
limits:
Expand Down Expand Up @@ -938,7 +938,7 @@ serviceAccount:
# Settings for importing data into GraphDB
import:
# Attach additional PV which will be used as an import directory
# See https://graphdb.ontotext.com/documentation/10.7/loading-data-using-the-workbench.html#importing-server-files
# See https://graphdb.ontotext.com/documentation/10.8/loading-data-using-the-workbench.html#importing-server-files
volumeMount:
# Toggles the attachment of the additional PV via StatefulSet's PVC templates.
enabled: false
Expand Down Expand Up @@ -1079,7 +1079,7 @@ jobs:

# The GraphDB Cluster Proxy is a separate StatefulSet that is enabled when the main GraphDB StatefulSet is deployed in cluster mode, i.e. replicas > 1.
# The proxy takes care of always routing traffic to the GraphDB leader node, reducing needless network hops by the internal proxy mechanism in GraphDB.
# See https://graphdb.ontotext.com/documentation/10.7/creating-a-cluster.html#configure-external-cluster-proxy
# See https://graphdb.ontotext.com/documentation/10.8/creating-a-cluster.html#configure-external-cluster-proxy
proxy:
# Overrides the name of the GraphDB proxy component.
nameOverride: ""
Expand All @@ -1103,7 +1103,7 @@ proxy:
################################

# GraphDB proxy runtime configuration settings.
# For reference, see https://graphdb.ontotext.com/documentation/10.7/directories-and-config-properties.html
# For reference, see https://graphdb.ontotext.com/documentation/10.8/directories-and-config-properties.html
configuration:
# GraphDB proxy properties to insert in the default graphdb.properties ConfigMap for the proxy.
# Values are processed as Helm templates.
Expand Down Expand Up @@ -1134,7 +1134,7 @@ proxy:
# GraphDB configuration properties can also be passed here in the format -Dprop=value
# Takes precedence over any configurations in graphdb.properties
# The value is processed as a Helm template.
# Ref: https://graphdb.ontotext.com/documentation/10.7/directories-and-config-properties.html#configuration
# Ref: https://graphdb.ontotext.com/documentation/10.8/directories-and-config-properties.html#configuration
defaultJavaArguments: -XX:+UseContainerSupport -XX:MaxRAMPercentage=70

# Java arguments to append after .Values.proxy.configuration.defaultJavaArguments
Expand All @@ -1143,7 +1143,7 @@ proxy:
javaArguments: ""

# Configurations for GraphDB's Logback
# Ref: https://graphdb.ontotext.com/documentation/10.7/diagnosing-and-reporting-critical-errors.html#logs
# Ref: https://graphdb.ontotext.com/documentation/10.8/diagnosing-and-reporting-critical-errors.html#logs
logback:
# Reference to an existing ConfigMap containing a Logback XML configuration.
# The value is processed as a Helm template.
Expand Down Expand Up @@ -1411,7 +1411,7 @@ proxy:
##########################

# Resource configurations for the GraphDB proxy containers.
# For resizing to your needs, refer to the GraphDB documentation https://graphdb.ontotext.com/documentation/10.7/requirements.html
# For resizing to your needs, refer to the GraphDB documentation https://graphdb.ontotext.com/documentation/10.8/requirements.html
# Ref: https://kubernetes.io/docs/tasks/configure-pod-container/assign-pods-nodes/
resources:
limits:
Expand Down

0 comments on commit 2113990

Please sign in to comment.