Skip to content

Commit

Permalink
[issue 100] - Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@fabiobrz
fabiobrz committed Oct 18, 2023
1 parent d938450 commit 09d07d1
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
46 changes: 23 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -245,23 +245,22 @@ public class PostgresqlProvisionTest {

Mapping of implemented provisioners:

| Product | Application | Provisioner | Notes |
|:-----------|:---------------------------------------|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ActiveMQ | ActiveMQOperatorApplication* | ActiveMQOperatorProvisioner | |
| Kafka | KafkaOperatorApplication | KafkaOperatorProvisioner | |
| Wildfly | WildflyImageOpenShiftApplication | WildflyImageOpenShiftProvisioner | Available both for Git sources and binary based s2i v2 build (either a pre-built deployment or a filesystem resource like a Maven project folder) |
| Wildfly | WildflyHelmChartOpenShiftApplication | WildflyHelmChartOpenShiftProvisioner | The `wildfly-2.3.2` tag of https://github.com/wildfly/wildfly-charts is used and the model is generated based on the https://raw.githubusercontent.com/wildfly/wildfly-charts/main/charts/wildfly/values.schema.json value schema file | |
| Infinispan | InfinispanOperatorApplication | InfinispanOperatorProvisioner | |
| Keycloak | KeycloakOperatorApplication | KeycloakOperatorProvisioner | |
| Keycloak | KeycloakRealmImportOperatorApplication | KeycloakRealmImportOperatorProvisioner | The latest Quarkus based Keycloak Operator, doesn't provide stable CRDs yet (see https://www.keycloak.org/2022/09/operator-crs); this operator offers a temporary solution which supports the `Keycloak` and `KeycloakRealmImport` Custom Resources: these are the only supported CR at the time of writing |

Additional services provisioners:

| Service | Application | Provisioner |
|:-----------|:---------------------------------------|:---------------------------------------|
| MySQL | MysqlImageOpenShiftApplication | MysqlImageOpenShiftProvisioner |
| PostgreSQL | PostgreSQLImageOpenShiftApplication | PostgreSQLImageOpenShiftProvisioner |
| PostgreSQL | PostgreSQLTemplateOpenShiftApplication | PostgreSQLTemplateOpenShiftProvisioner |
| Service | Supports community project | Supports product | Application | Provisioner | Notes |
|:--------------------------------------|:---------------------------|:-------------------|:---------------------------------------|:--------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ActiveMQ Artemis & Red Hat AMQ Broker | :heavy_check_mark: | :heavy_check_mark: | ActiveMQOperatorApplication | ActiveMQOperatorProvisioner | Operator based provisioner, see details [below](#operator-based-provisioning) |
| HyperFoil | :heavy_check_mark: | :x: | HyperfoilOperatorApplication | HyperfoilOperatorProvisioner | Operator based provisioner, see details [below](#operator-based-provisioning) |
| Infinispan & Red Hat DataGrid | :heavy_check_mark: | :heavy_check_mark: | InfinispanOperatorApplication | InfinispanOperatorProvisioner | Operator based provisioner, see details [below](#operator-based-provisioning) |
| Kafka & Red Hat AMQ Streams | :heavy_check_mark: | :heavy_check_mark: | KafkaOperatorApplication | KafkaOperatorProvisioner | Operator based provisioner, see details [below](#operator-based-provisioning) |
| Keycloak | :heavy_check_mark: | :x: | KeycloakRealmImportOperatorApplication | KeycloakRealmImportOperatorProvisioner | Based on the latest Quarkus based Keycloak Operator, doesn't provide stable CRDs yet (see https://www.keycloak.org/2022/09/operator-crs); this operator offers a solution which supports the `Keycloak` and `KeycloakRealmImport` Custom Resources: these are the only supported CRs at the time of writing. See details [below](#operator-based-provisioning) |
| MySQL | :heavy_check_mark: | :x: | MysqlImageOpenShiftApplication | MysqlImageOpenShiftProvisioner | Deploys a MySQL image and sets environment variables to configure the service (ports, credentials etc.) |
| PostgreSQL | :heavy_check_mark: | :x: | PostgreSQLImageOpenShiftApplication | PostgreSQLImageOpenShiftProvisioner | Deploys a PostgreSQL image and sets environment variables to configure the service (ports, credentials etc.) |
| Wildfly & Red Hat JBoss EAP XP | :heavy_check_mark: | :heavy_check_mark: | BootableJarOpenShiftApplication | WildflyBootableJarImageOpenShiftProvisioner | Deploys a WildFly Bootable JAR, i.e. a runnable WildFly application |
| Wildfly & Red Hat JBoss EAP 8 | :heavy_check_mark: | :heavy_check_mark: | WildflyImageOpenShiftApplication | WildflyImageOpenShiftProvisioner | Available both for Git sources and binary based s2i v2 build (either a pre-built deployment or a filesystem resource like a Maven project folder) |
| Wildfly & Red Hat JBoss EAP 8 | :heavy_check_mark: | :heavy_check_mark: | WildflyHelmChartOpenShiftApplication | WildflyHelmChartOpenShiftProvisioner | The `wildfly-2.3.2` tag of https://github.com/wildfly/wildfly-charts is used and the model is generated based on the https://raw.githubusercontent.com/wildfly/wildfly-charts/main/charts/wildfly/values.schema.json value schema file |
| Wildfly & Red Hat JBoss EAP 7/8 | :heavy_check_mark: | :heavy_check_mark: | WildflyOperatorApplication | WildflyOperatorProvisioner | Operator based provisioner, see details [below](#operator-based-provisioning) |
| Red Hat JBoss EAP 7 | :x: | :heavy_check_mark: | Eap7ImageOpenShiftApplication | Eap7ImageOpenShiftProvisioner | Available both for Git sources and binary based EAP 7 s2i (legacy) build, i.e. based on a pre-built deployment (i.e. a _WAR archive_) |
| Red Hat SSO 7 | :x: | :heavy_check_mark: | RhSsoOperatorApplication | RhSsoOperatorProvisioner | Based on the archived Keycloak operator project, which contains the latest Red Hat SSO 7.z CRDs definitions, see details [below](#operator-based-provisioning) |


The only thing users have to take care of is to implement the correct `Application` (see the table above) interface and
pass the class via `@Service` annotation, it's a task for the framework to choose a suitable Provisioner implementation
Expand All @@ -277,18 +276,19 @@ a given service on cloud environments via APIs that leverage the
Intersmash makes this feature available for currently supported products (see the table below), but that can be
extended easily, since Intersmash _provisioners_ are pluggable components.

| Product | Supported Operator version | Channel name | Supported product version | Repository | Notes |
| Service | Supported Operator version | Channel name | Supported product version | Repository | Notes |
|:--------------------------|:---------------------------|:-------------|:--------------------------|:----------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ActiveMQ Artemis | 1.0.11 | upstream | 1.0.15 | https://github.com/artemiscloud/activemq-artemis-operator | We are using a custom index image, i.e. quay.io/jbossqe-eap/intersmash-activemq-operator-catalog:v1.0.11, built as described in https://github.com/Intersmash/intersmash/issues/32 |
| Red HatAMQ Broker | 7.11.2-opr-1 | 7.11.x | 7.11.z | https://github.com/rh-messaging/activemq-artemis-operator | As available on the OpenShift OperatorHub |
| Hyperfoil | 0.24.2 | alpha | 0.24.2 | https://github.com/Hyperfoil/hyperfoil-operator | We force the CRs version for the used Hyperfoil runtime to be 0.24.2, see https://github.com/Hyperfoil/hyperfoil-operator/issues/18 |
| Infinispan | 2.3.4 | 2.3.x | 14.0.17.Final | https://github.com/infinispan/infinispan-operator | As available on the OpenShift OperatorHub (community-operators) |
| Red Hat DataGrid | 8.4.8 | 8.4.x | 8.4.4.GA | https://github.com/infinispan/infinispan-operator | As available on the OpenShift OperatorHub |
| WildFly | 0.5.6 | alpha | 29.0.1.Final | https://github.com/wildfly/wildfly-operator | As available on https://operatorhub.io/operator/wildfly |
| Red Hat JBoss EAP | 2.4.2 | stable | EAP 8.0 Beta, EAP 7.4.z | https://github.com/wildfly/wildfly-operator | As available on the OpenShift OperatorHub |
| Kafka provided by Strimzi | 0.37.0-SNAPSHOT | stable | 3.5.1 | https://github.com/strimzi/strimzi-kafka-operator | A snapshot version of Strimzi API is used in order to be compatible with Fabric8 Kubernetes client artifacts |
| Red HatAMQ Streams | 2.5.0-0 | stable | 3.5.0 | https://github.com/strimzi/strimzi-kafka-operator | As available on the OpenShift OperatorHub. A snapshot version of Strimzi API is used in order to be compatible with Fabric8 Kubernetes client artifacts |
| ActiveMQ Artemis | 1.0.11 | upstream | 1.0.15 | https://github.com/artemiscloud/activemq-artemis-operator | We are using a custom index image, i.e. quay.io/jbossqe-eap/intersmash-activemq-operator-catalog:v1.0.11, built as described in https://github.com/Intersmash/intersmash/issues/32 |
| Red HatAMQ Broker | 7.11.2-opr-1 | 7.11.x | 7.11.z | https://github.com/rh-messaging/activemq-artemis-operator | As available on the OpenShift OperatorHub |
| Red Hat AMQ Streams | 2.5.0-0 | stable | 3.5.0 | https://github.com/strimzi/strimzi-kafka-operator | As available on the OpenShift OperatorHub. A snapshot version of Strimzi API is used in order to be compatible with Fabric8 Kubernetes client artifacts |
| Keycloak | 22.0.4 | upstream | 22.0.4 | https://github.com/keycloak/keycloak/tree/main/operator | Latest Keycloak, based on Quarkus. Supports a limited number of CR (Keycloak and KeycloakRealmImport): more to come in upcoming versions |
| Red Hat SSO | 7.6.5-opr-003 | stable | 7.4.6 | https://github.com/keycloak/keycloak-operator | Latest Red Hat SSO Operator, based on legacy Keycloak |
| WildFly | 0.5.6 | alpha | 29.0.1.Final | https://github.com/wildfly/wildfly-operator | As available on https://operatorhub.io/operator/wildfly |
| Red Hat JBoss EAP | 2.4.2 | stable | EAP 8.0 Beta, EAP 7.4.z | https://github.com/wildfly/wildfly-operator | As available on the OpenShift OperatorHub |

Intersmash operator-based provisioners implement a common contract and high level behavior which is defined by the
[OperatorProvisioner](./intersmash-tools/intersmash-tools-core/src/main/java/org/jboss/intersmash/tools/provision/openshift/operator/OperatorProvisioner.java)
Expand Down
Loading

0 comments on commit 09d07d1

Please sign in to comment.