Skip to content

Commit 20c04bb

Browse files
andreaTPandreaTP
authored
Add a basic Sql Datasource for operator (#5363)
1 parent 6865792 commit 20c04bb

File tree

6 files changed

+214
-1
lines changed

6 files changed

+214
-1
lines changed

‎operator/controller/src/main/java/io/apicurio/registry/operator/resource/app/AppDeploymentResource.java

+28
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import io.apicurio.registry.operator.OperatorException;
44
import io.apicurio.registry.operator.api.v1.ApicurioRegistry3;
5+
import io.apicurio.registry.operator.api.v1.spec.Sql;
56
import io.fabric8.kubernetes.api.model.Container;
67
import io.fabric8.kubernetes.api.model.EnvVar;
78
import io.fabric8.kubernetes.api.model.EnvVarBuilder;
@@ -33,6 +34,12 @@ public class AppDeploymentResource extends CRUDKubernetesDependentResource<Deplo
3334

3435
private static final Logger log = LoggerFactory.getLogger(AppDeploymentResource.class);
3536

37+
public static final String ENV_APICURIO_STORAGE_KIND = "APICURIO_STORAGE_KIND";
38+
public static final String ENV_APICURIO_STORAGE_SQL_KIND = "APICURIO_STORAGE_SQL_KIND";
39+
public static final String ENV_APICURIO_DATASOURCE_URL = "APICURIO_DATASOURCE_URL";
40+
public static final String ENV_APICURIO_DATASOURCE_USERNAME = "APICURIO_DATASOURCE_USERNAME";
41+
public static final String ENV_APICURIO_DATASOURCE_PASSWORD = "APICURIO_DATASOURCE_PASSWORD";
42+
3643
public AppDeploymentResource() {
3744
super(Deployment.class);
3845
}
@@ -58,13 +65,34 @@ protected Deployment desired(ApicurioRegistry3 primary, Context<ApicurioRegistry
5865
addEnvVar(envVars, new EnvVarBuilder().withName("APICURIO_APIS_V2_DATE_FORMAT").withValue("yyyy-MM-dd''T''HH:mm:ssZ").build());
5966
// spotless:on
6067

68+
configureSqlDatasource(envVars, primary.getSpec().getApp().getSql());
69+
6170
var container = getContainer(d, APP_CONTAINER_NAME);
6271
container.setEnv(envVars.values().stream().toList());
6372

6473
log.debug("Desired {} is {}", APP_DEPLOYMENT_KEY.getId(), toYAML(d));
6574
return d;
6675
}
6776

77+
private static void configureSqlDatasource(Map<String, EnvVar> map, Sql sql) {
78+
if (sql != null && sql.getDatasource() != null) {
79+
var datasource = sql.getDatasource();
80+
81+
addEnvVar(map, new EnvVarBuilder().withName(ENV_APICURIO_STORAGE_KIND).withValue("sql").build());
82+
addEnvVar(map, new EnvVarBuilder().withName(ENV_APICURIO_STORAGE_SQL_KIND).withValue("postgresql")
83+
.build());
84+
85+
addEnvVar(map, new EnvVarBuilder().withName(ENV_APICURIO_DATASOURCE_URL)
86+
.withValue(datasource.getUrl()).build());
87+
addEnvVar(map, new EnvVarBuilder().withName(ENV_APICURIO_DATASOURCE_USERNAME)
88+
.withValue(datasource.getUsername()).build());
89+
addEnvVar(map, new EnvVarBuilder().withName(ENV_APICURIO_DATASOURCE_PASSWORD)
90+
.withValue(datasource.getPassword()).build());
91+
} else {
92+
log.info("No SQL datasource configured");
93+
}
94+
}
95+
6896
public static void addEnvVar(Map<String, EnvVar> map, EnvVar envVar) {
6997
if (!map.containsKey(envVar.getName())) {
7098
map.put(envVar.getName(), envVar);

‎operator/controller/src/test/java/io/apicurio/registry/operator/it/SqlDatasourceITTest.java

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
package io.apicurio.registry.operator.it;
2+
3+
import io.apicurio.registry.operator.api.v1.ApicurioRegistry3;
4+
import io.apicurio.registry.operator.api.v1.spec.Sql;
5+
import io.apicurio.registry.operator.api.v1.spec.sql.Datasource;
6+
import io.apicurio.registry.operator.resource.ResourceFactory;
7+
import io.quarkus.test.junit.QuarkusTest;
8+
import org.junit.jupiter.api.Test;
9+
import org.slf4j.Logger;
10+
import org.slf4j.LoggerFactory;
11+
12+
import static org.assertj.core.api.Assertions.assertThat;
13+
import static org.awaitility.Awaitility.await;
14+
15+
@QuarkusTest
16+
public class SqlDatasourceITTest extends ITBase {
17+
18+
private static final Logger log = LoggerFactory.getLogger(SqlDatasourceITTest.class);
19+
20+
@Test
21+
void testSqlDatasource() {
22+
client.load(SqlDatasourceITTest.class.getResourceAsStream("/k8s/example-postgres.yaml")).create();
23+
// await for postgres to be available
24+
await().ignoreExceptions().until(() -> (1 == client.apps().statefulSets().inNamespace(namespace)
25+
.withName("postgresql-db").get().getStatus().getReadyReplicas()));
26+
27+
var registry = ResourceFactory.deserialize("/k8s/examples/simple.apicurioregistry3.yaml",
28+
ApicurioRegistry3.class);
29+
registry.getMetadata().setNamespace(namespace);
30+
var sql = new Sql();
31+
registry.getSpec().getApp().setSql(sql);
32+
var datasource = new Datasource();
33+
sql.setDatasource(datasource);
34+
datasource.setUrl("jdbc:postgresql://postgres-db:5432/apicurio");
35+
datasource.setUsername("postgres-username");
36+
datasource.setPassword("postgres-password");
37+
38+
client.resource(registry).create();
39+
40+
await().ignoreExceptions().until(() -> {
41+
assertThat(client.apps().deployments().inNamespace(namespace)
42+
.withName(registry.getMetadata().getName() + "-app-deployment").get().getStatus()
43+
.getReadyReplicas().intValue()).isEqualTo(1);
44+
var podName = client.pods().inNamespace(namespace).list().getItems().stream()
45+
.map(pod -> pod.getMetadata().getName())
46+
.filter(podN -> podN.startsWith("simple-app-deployment")).findFirst().get();
47+
assertThat(client.pods().inNamespace(namespace).withName(podName).getLog())
48+
.contains("Database type: postgresql");
49+
50+
return true;
51+
});
52+
}
53+
}

‎operator/controller/src/test/resources/k8s/example-postgres.yaml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# PostgreSQL StatefulSet
2+
apiVersion: apps/v1
3+
kind: StatefulSet
4+
metadata:
5+
name: postgresql-db
6+
spec:
7+
serviceName: postgresql-db-service
8+
selector:
9+
matchLabels:
10+
app: postgresql-db
11+
replicas: 1
12+
template:
13+
metadata:
14+
labels:
15+
app: postgresql-db
16+
spec:
17+
containers:
18+
- name: postgresql-db
19+
image: quay.io/sclorg/postgresql-15-c9s:latest
20+
volumeMounts:
21+
- mountPath: /var/lib/pgsql/data
22+
name: cache-volume
23+
env:
24+
- name: POSTGRESQL_USER
25+
value: postgres-username
26+
- name: POSTGRESQL_PASSWORD
27+
value: postgres-password
28+
- name: POSTGRESQL_DATABASE
29+
value: apicurio
30+
volumes:
31+
- name: cache-volume
32+
emptyDir: {}
33+
---
34+
# PostgreSQL StatefulSet Service
35+
apiVersion: v1
36+
kind: Service
37+
metadata:
38+
name: postgres-db
39+
spec:
40+
selector:
41+
app: postgresql-db
42+
ports:
43+
- port: 5432
44+
targetPort: 5432

‎operator/model/src/main/java/io/apicurio/registry/operator/api/v1/ApicurioRegistry3SpecApp.java

+8-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import com.fasterxml.jackson.annotation.JsonInclude.Include;
55
import com.fasterxml.jackson.databind.JsonDeserializer.None;
66
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
7+
import io.apicurio.registry.operator.api.v1.spec.Sql;
78
import io.fabric8.kubernetes.api.model.EnvVar;
89
import io.fabric8.kubernetes.api.model.KubernetesResource;
910
import lombok.*;
@@ -12,7 +13,7 @@
1213
import java.util.List;
1314

1415
@JsonInclude(Include.NON_NULL)
15-
@JsonPropertyOrder({ "env", "host" })
16+
@JsonPropertyOrder({ "env", "host", "sql" })
1617
@JsonDeserialize(using = None.class)
1718
@NoArgsConstructor
1819
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@@ -47,4 +48,10 @@ public class ApicurioRegistry3SpecApp implements KubernetesResource {
4748
If you create the Ingress manually, you have to manually set the REGISTRY_API_URL environment variable for the backend component.""")
4849
@JsonSetter(nulls = Nulls.SKIP)
4950
private String host;
51+
52+
@JsonProperty("sql")
53+
@JsonPropertyDescription("""
54+
Configuration of Apicurio Registry SQL storage.""")
55+
@JsonSetter(nulls = Nulls.SKIP)
56+
private Sql sql;
5057
}

‎operator/model/src/main/java/io/apicurio/registry/operator/api/v1/spec/Sql.java

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
package io.apicurio.registry.operator.api.v1.spec;
2+
3+
import com.fasterxml.jackson.annotation.JsonInclude;
4+
import com.fasterxml.jackson.annotation.JsonProperty;
5+
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
6+
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
7+
import com.fasterxml.jackson.annotation.JsonSetter;
8+
import com.fasterxml.jackson.annotation.Nulls;
9+
import com.fasterxml.jackson.databind.JsonDeserializer;
10+
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
11+
import io.apicurio.registry.operator.api.v1.spec.sql.Datasource;
12+
import lombok.Getter;
13+
import lombok.Setter;
14+
import lombok.ToString;
15+
16+
@JsonInclude(JsonInclude.Include.NON_NULL)
17+
@JsonPropertyOrder({ "datasource" })
18+
@JsonDeserialize(using = JsonDeserializer.None.class)
19+
@Getter
20+
@Setter
21+
@ToString
22+
public class Sql {
23+
24+
@JsonProperty("datasource")
25+
@JsonPropertyDescription("""
26+
SQL data source.""")
27+
@JsonSetter(nulls = Nulls.SKIP)
28+
private Datasource datasource;
29+
30+
}

‎operator/model/src/main/java/io/apicurio/registry/operator/api/v1/spec/sql/Datasource.java

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
package io.apicurio.registry.operator.api.v1.spec.sql;
2+
3+
import com.fasterxml.jackson.annotation.JsonInclude;
4+
import com.fasterxml.jackson.annotation.JsonProperty;
5+
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
6+
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
7+
import com.fasterxml.jackson.annotation.JsonSetter;
8+
import com.fasterxml.jackson.annotation.Nulls;
9+
import com.fasterxml.jackson.databind.JsonDeserializer;
10+
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
11+
import lombok.Getter;
12+
import lombok.Setter;
13+
import lombok.ToString;
14+
15+
@JsonInclude(JsonInclude.Include.NON_NULL)
16+
@JsonPropertyOrder({ "url", "username", "password" })
17+
@JsonDeserialize(using = JsonDeserializer.None.class)
18+
@Getter
19+
@Setter
20+
@ToString
21+
public class Datasource {
22+
23+
@JsonProperty("url")
24+
@JsonPropertyDescription("""
25+
Data source URL: \\n URL of the PostgreSQL
26+
database, for example: `jdbc:postgresql://<service name>.<namespace>.svc:5432/<database name>`.""")
27+
@JsonSetter(nulls = Nulls.SKIP)
28+
private String url;
29+
30+
@JsonProperty("username")
31+
@JsonPropertyDescription("""
32+
Data source username.""")
33+
@JsonSetter(nulls = Nulls.SKIP)
34+
private String username;
35+
36+
@JsonProperty("password")
37+
@JsonPropertyDescription("""
38+
Data source password.""")
39+
@JsonSetter(nulls = Nulls.SKIP)
40+
private String password;
41+
42+
// TODO: support values from Secrets:
43+
//
44+
// Proposal to support secrets, add alternative fields like:
45+
// @JsonProperty("passwordFrom")
46+
// @JsonPropertyDescription("""
47+
// Data source password from Secret/ConfigMap/...""")
48+
// @JsonSetter(nulls = Nulls.SKIP)
49+
// private EnvVarSource passwordFrom;
50+
51+
}

0 commit comments

Comments
 (0)