Skip to content

Release 3.11 (September 2022)

Known Issues

This section highlights any significant issues to be aware of. Refer to our GitHub Issues for a full list of open issues or to open a new one.

Use chromium-based or Safari browser for UIs

It is recommended to use a chromium-based browser such as Google Chrome, Microsoft Edge or Apple Safari for the Egeria Ecosystem UI. Some parts of the UI experience such as Dino currently experience problems with Firefox. See odpi/egeria-react-ui#96 .

Ecosystem UI minor issues

We are continuing to develop the Ecosystem UI & improve it's capability and usability. These are not regressions in this release. Known issues include:

See odpi/egeria-react-ui for all issues or to open a new one on this UI.

Documentation Link errors

We are aware of broken links in the documentation here, as well as broken links to the documentation contained within the Egeria code - for example links to component information.

We are trying to fix these as we update the docs, but please raise any additional problems found in egeria-docs. We would also be very grateful for any PRs that fix issues.

Kafka consumer group id could not be set

odpi/egeria#6638 has now been fixed.

This addresses a situation where the ability to override the kafka consumer group id was not working correctly.

  • If no consumer group id is set then the current behaviour continues -- we use the server id as default, both for the default event bus config, as well as during the setup of embedded connections (default)
  • If local.server.id is specified in the default event bus config, this is used for all additional connections (intent of old behaviour)
  • If group.id is specified in the consumer properties, this is used instead (higher priority) (more standard approach)
Lost Cohort membership - Initial kafka offset was incorrect

odpi/egeria#6712 has addressed a situation where the initial seek position to read kafka messages from was incorrectly set. This mostly affected initial configuration/setup and automated tests (which always start clean) since the start offset is not already stored. In these cases cohort membership would not be complete - so some servers would not see other servers.

This was the cause of the intermittent issues referred to in previous release notes.

This is now fixed.

Open Metadata Types
  • The ProfileLocation relationship between ActorProfile and Location has been added to model 0110 Actors.
  • The AssignmentScope relationship between two Referenceable entities has been added to model 0120 Assignment Scopes. The ProjectScope and GovernanceRoleAssignment relationships are deprecated in favour of this new relationship.
  • New parameters stewardTypeName and stewardPropertyName have been added to the ValidValuesMapping and ReferenceValueAssignment relationships to allow the steward to be represented by a UserIdentity, a PersonRole or an ActorProfile. See model 0545.
  • The ValidValuesImplementation becomes a multi-link relationship.
  • The status attribute on Project is deprecated in favour of the more specific projectStatus attribute, which makes it easier to align with an appropriate valid value set.
  • New parameters name and contactType have been added to the ContactDetails entity to allow more detail about a contact method to be captured. See model 0110.
  • New parameter pronouns has been added to the Person entity to capture an individual's pronoun preferences. See model 0112.
  • New parameter identifier has been added to the Team entity to capture code identifers allocated to teams. See model 0115.
  • A new relationship called Stakeholder has been added to link ActorProfiles with Referenceables. See model 0130.
  • The BusinessCapabilityControls relationship is deprecated in favour of the more generic GovernanceDefinitionScope.
  • The TranslationDetail entity and TranslationLink relationship are added to model 0022.
Additional HTTP headers can now be passed to security plugins

Additional HTTP headers can now be passed to security plugins, and will also be propogated on federated queries

See odpi/egeria#5700 for the implementation.

These notes will be updated with further information as it becomes available.

Helm charts - Installing multiple charts on the same k8s cluster

The charts have been updated to allow multiple installs on the same cluster. Previously this was not possible due to the default Strimzi install (included in the charts below) creating a cluster-wide resource.

To allow co-existance:

  • install Strimzi manually, ensuring the operator watches ALL namespaces
  • Add '--set strimzi.enabled=false' to any Helm install of Egeria charts, so that they do not install the Strimzi operator

See docs for more information

Helm charts - Installing additional connectors

Additional connectors can now be specified when installing with both the 'base' and 'odpi-egeria-lab' charts.

The specified files will be downloaded into /deployment/server/extralib & be available within the classpath, ready to be loaded as needed.

Both a URL and a filename MUST be specified. For example below we obtain the xtdb and postgres connectors, plus a jdbc driver:

In a file ~/extra.yaml add:

extralibs:
- url: https://search.maven.org/remotecontent?filepath=org/odpi/egeria/egeria-connector-xtdb/3.10/egeria-connector-xtdb-3.10-jar-with-dependencies.jar
  filename: egeria-connector-xtdb-3.10-jar-with-dependencies.jar
- url: https://oss.sonatype.org/service/local/repositories/snapshots/content/org/odpi/egeria/egeria-connector-postgres/3.11-SNAPSHOT/egeria-connector-postgres-3.11-20220826.091931-1.jar
  filename: egeria-connector-postgres.jar
- url: https://jdbc.postgresql.org/download/postgresql-42.5.0.jar
  filename: postgresql.jar
Then when installing specify these as configuration overrides ie:
helm install base egeria/base -f ~/etc/extra.yaml

If any connectors cannot be loaded the Egeria pods will not start, and the configuration will need to be corrected.

Helm charts / containers / source - Changes to Jupyter notebooks

Jupyter notebook source has now moved to a new repository.

The Egeria Jupyter notebooks container, used in our lab Helm chart, no longer contains our Jupyter notebooks. Instead it contains only the Jupyter code with minimal changes required for security.

The Jupyter notebooks are now downloaded at startup from the new GitHub repository, controlled by the Helm chart definitions. This will always retrieve the latest, main branch.

Additionally the Jupyter pod now uses https by default, and a login token is REQUIRED. To obtain this token, view the output from the Jupyter pod ie:

➜  master git:(master) kubectl get pods | grep jupyter
lab-odpi-egeria-lab-jupyter-7d9798d75-lwdgb        1/1     Running   1 (3h53m ago)   3h54m
➜  master git:(master) kubectl logs lab-odpi-egeria-lab-jupyter-7d9798d75-lwdgb | grep TOKEN
➜  master git:(master) kubectl logs lab-odpi-egeria-lab-jupyter-7d9798d75-lwdgb | grep -y token
[I 2022-08-31 16:18:30.730 ServerApp] https://lab-odpi-egeria-lab-jupyter-7d9798d75-lwdgb:8888/lab?token=091f2f66a76152b40b7ae2056ace8719bd57faa42fcbb286
[I 2022-08-31 16:18:30.730 ServerApp]  or https://127.0.0.1:8888/lab?token=091f2f66a76152b40b7ae2056ace8719bd57faa42fcbb286
https://lab-odpi-egeria-lab-jupyter-7d9798d75-lwdgb:8888/lab?token=091f2f66a76152b40b7ae2056ace8719bd57faa42fcbb286
or https://127.0.0.1:8888/lab?token=091f2f66a76152b40b7ae2056ace8719bd57faa42fcbb286
➜  master git:(master)

This value will be required when logging into the Jupyter UI.

Note that this token is regenerated when the pod restarts. This may be made persistent in a future update.

Helm Chart versions

These charts may get updated more frequently than Egeria code releases, as we integrate other components and fix bugs. You can always check the latest with helm repo update && helm search repo egeria

Note that the Business UI remains at an older version, as the code is currently undergoing some refactoring.

To see known issues/upcoming work or to report issues see egeria-charts

Tested environments

The Egeria charts have been tested in:

  • Rancher Desktop 1.5.1
  • Red Hat OpenShift 4.10
Lab Chart for 3.10

The Egeria lab chart 3.10.0 has been updated to include:

  • Egeria 3.11
  • Egeria Ecosystem UI 3.8.0
  • Egeria Business UI 3.2.0
  • Strimzi 0.30
Base Chart for 3.10

The Egeria base chart 3.10.0 has been updated to include:

  • Egeria 3.11
  • Egeria Ecosystem UI 3.8.0
  • Strimzi 0.30
CTS & PTS Charts for 3.10
  • Egeria 3.11
  • Strimzi 0.30
Bug fixes and other updates

For details on core Egeria changes, see the GitHub release note for 3.11 and the full commit history in GitHub .