Skip to content

Commit d05dcd9

Browse files
krasi-georgievkrasi-georgiev
committed
Use API as the name everywhere to make it consistent.
Signed-off-by: Krasi Georgiev <[email protected]>
1 parent 1f9458d commit d05dcd9

File tree

8 files changed

+78
-78
lines changed

8 files changed

+78
-78
lines changed

Diff for: ‎docs/benchmark.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Benchmark baseline results
22

3-
This document contains baseline benchmark results for Observatorium API Gateway under synthetic load.
3+
This document contains baseline benchmark results for Observatorium API under synthetic load.
44

55
Tested on:
66

@@ -14,7 +14,7 @@ Generated using:
1414

1515
[embedmd]:# (../tmp/load_help.txt)
1616
```txt
17-
load.sh [-h] [-r n] [-c n] [-m n] [-q n] [-o csv|gnuplot] -- program to test synthetic load on observatorium gateway and report results.
17+
load.sh [-h] [-r n] [-c n] [-m n] [-q n] [-o csv|gnuplot] -- program to test synthetic load on observatorium api and report results.
1818
1919
where:
2020
-h show this help text

Diff for: ‎examples/manifests/deployment-with-tls.yaml

+11-11
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,29 @@ apiVersion: apps/v1
22
kind: Deployment
33
metadata:
44
labels:
5-
app.kubernetes.io/component: api-gateway
6-
app.kubernetes.io/instance: observatorium-api-gateway
7-
app.kubernetes.io/name: observatorium-api-gateway
5+
app.kubernetes.io/component: api
6+
app.kubernetes.io/instance: observatorium-api
7+
app.kubernetes.io/name: observatorium-api
88
app.kubernetes.io/version: master-2020-01-28-e009b4a
9-
name: observatorium-api-gateway
9+
name: observatorium-api
1010
namespace: observatorium
1111
spec:
1212
replicas: 3
1313
selector:
1414
matchLabels:
15-
app.kubernetes.io/component: api-gateway
16-
app.kubernetes.io/instance: observatorium-api-gateway
17-
app.kubernetes.io/name: observatorium-api-gateway
15+
app.kubernetes.io/component: api
16+
app.kubernetes.io/instance: observatorium-api
17+
app.kubernetes.io/name: observatorium-api
1818
strategy:
1919
rollingUpdate:
2020
maxSurge: 0
2121
maxUnavailable: 1
2222
template:
2323
metadata:
2424
labels:
25-
app.kubernetes.io/component: api-gateway
26-
app.kubernetes.io/instance: observatorium-api-gateway
27-
app.kubernetes.io/name: observatorium-api-gateway
25+
app.kubernetes.io/component: api
26+
app.kubernetes.io/instance: observatorium-api
27+
app.kubernetes.io/name: observatorium-api
2828
app.kubernetes.io/version: master-2020-01-28-e009b4a
2929
spec:
3030
containers:
@@ -46,7 +46,7 @@ spec:
4646
port: 8080
4747
scheme: HTTP
4848
periodSeconds: 30
49-
name: observatorium-api-gateway
49+
name: observatorium-api
5050
ports:
5151
- containerPort: 8080
5252
name: http

Diff for: ‎examples/manifests/deployment.yaml

+11-11
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,29 @@ apiVersion: apps/v1
22
kind: Deployment
33
metadata:
44
labels:
5-
app.kubernetes.io/component: api-gateway
6-
app.kubernetes.io/instance: observatorium-api-gateway
7-
app.kubernetes.io/name: observatorium-api-gateway
5+
app.kubernetes.io/component: api
6+
app.kubernetes.io/instance: observatorium-api
7+
app.kubernetes.io/name: observatorium-api
88
app.kubernetes.io/version: master-2020-01-28-e009b4a
9-
name: observatorium-api-gateway
9+
name: observatorium-api
1010
namespace: observatorium
1111
spec:
1212
replicas: 3
1313
selector:
1414
matchLabels:
15-
app.kubernetes.io/component: api-gateway
16-
app.kubernetes.io/instance: observatorium-api-gateway
17-
app.kubernetes.io/name: observatorium-api-gateway
15+
app.kubernetes.io/component: api
16+
app.kubernetes.io/instance: observatorium-api
17+
app.kubernetes.io/name: observatorium-api
1818
strategy:
1919
rollingUpdate:
2020
maxSurge: 0
2121
maxUnavailable: 1
2222
template:
2323
metadata:
2424
labels:
25-
app.kubernetes.io/component: api-gateway
26-
app.kubernetes.io/instance: observatorium-api-gateway
27-
app.kubernetes.io/name: observatorium-api-gateway
25+
app.kubernetes.io/component: api
26+
app.kubernetes.io/instance: observatorium-api
27+
app.kubernetes.io/name: observatorium-api
2828
app.kubernetes.io/version: master-2020-01-28-e009b4a
2929
spec:
3030
containers:
@@ -42,7 +42,7 @@ spec:
4242
port: 8080
4343
scheme: HTTP
4444
periodSeconds: 30
45-
name: observatorium-api-gateway
45+
name: observatorium-api
4646
ports:
4747
- containerPort: 8080
4848
name: http

Diff for: ‎examples/manifests/service-with-tls.yaml

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@ apiVersion: v1
22
kind: Service
33
metadata:
44
labels:
5-
app.kubernetes.io/component: api-gateway
6-
app.kubernetes.io/instance: observatorium-api-gateway
7-
app.kubernetes.io/name: observatorium-api-gateway
5+
app.kubernetes.io/component: api
6+
app.kubernetes.io/instance: observatorium-api
7+
app.kubernetes.io/name: observatorium-api
88
app.kubernetes.io/version: master-2020-01-28-e009b4a
9-
name: observatorium-api-gateway
9+
name: observatorium-api
1010
namespace: observatorium
1111
spec:
1212
ports:
1313
- name: http
1414
port: 8080
1515
targetPort: 8080
1616
selector:
17-
app.kubernetes.io/component: api-gateway
18-
app.kubernetes.io/instance: observatorium-api-gateway
19-
app.kubernetes.io/name: observatorium-api-gateway
17+
app.kubernetes.io/component: api
18+
app.kubernetes.io/instance: observatorium-api
19+
app.kubernetes.io/name: observatorium-api

Diff for: ‎examples/manifests/service.yaml

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@ apiVersion: v1
22
kind: Service
33
metadata:
44
labels:
5-
app.kubernetes.io/component: api-gateway
6-
app.kubernetes.io/instance: observatorium-api-gateway
7-
app.kubernetes.io/name: observatorium-api-gateway
5+
app.kubernetes.io/component: api
6+
app.kubernetes.io/instance: observatorium-api
7+
app.kubernetes.io/name: observatorium-api
88
app.kubernetes.io/version: master-2020-01-28-e009b4a
9-
name: observatorium-api-gateway
9+
name: observatorium-api
1010
namespace: observatorium
1111
spec:
1212
ports:
1313
- name: http
1414
port: 8080
1515
targetPort: 8080
1616
selector:
17-
app.kubernetes.io/component: api-gateway
18-
app.kubernetes.io/instance: observatorium-api-gateway
19-
app.kubernetes.io/name: observatorium-api-gateway
17+
app.kubernetes.io/component: api
18+
app.kubernetes.io/instance: observatorium-api
19+
app.kubernetes.io/name: observatorium-api

Diff for: ‎jsonnet/lib/observatorium-api.libsonnet

+34-34
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
local k = import 'ksonnet/ksonnet.beta.4/k.libsonnet';
22

33
{
4-
local gateway = self,
4+
local api = self,
55

66
config:: {
77
name: error 'must provide name',
@@ -14,15 +14,15 @@ local k = import 'ksonnet/ksonnet.beta.4/k.libsonnet';
1414
writeEndpoint: error 'must provide writeEndpoint',
1515

1616
commonLabels:: {
17-
'app.kubernetes.io/name': 'observatorium-api-gateway',
18-
'app.kubernetes.io/instance': gateway.config.name,
19-
'app.kubernetes.io/version': gateway.config.version,
20-
'app.kubernetes.io/component': 'api-gateway',
17+
'app.kubernetes.io/name': 'observatorium-api',
18+
'app.kubernetes.io/instance': api.config.name,
19+
'app.kubernetes.io/version': api.config.version,
20+
'app.kubernetes.io/component': 'api',
2121
},
2222

2323
podLabelSelector:: {
24-
[labelName]: gateway.config.commonLabels[labelName]
25-
for labelName in std.objectFields(gateway.config.commonLabels)
24+
[labelName]: api.config.commonLabels[labelName]
25+
for labelName in std.objectFields(api.config.commonLabels)
2626
if !std.setMember(labelName, ['app.kubernetes.io/version'])
2727
},
2828
},
@@ -32,27 +32,27 @@ local k = import 'ksonnet/ksonnet.beta.4/k.libsonnet';
3232
local ports = service.mixin.spec.portsType;
3333

3434
service.new(
35-
gateway.config.name,
36-
gateway.config.podLabelSelector,
35+
api.config.name,
36+
api.config.podLabelSelector,
3737
[
3838
ports.newNamed('http', 8080, 8080),
3939
],
4040
) +
41-
service.mixin.metadata.withNamespace(gateway.config.namespace) +
42-
service.mixin.metadata.withLabels(gateway.config.commonLabels),
41+
service.mixin.metadata.withNamespace(api.config.namespace) +
42+
service.mixin.metadata.withLabels(api.config.commonLabels),
4343

4444
deployment:
4545
local deployment = k.apps.v1.deployment;
4646
local container = deployment.mixin.spec.template.spec.containersType;
4747
local containerPort = container.portsType;
4848

4949
local c =
50-
container.new('observatorium-api-gateway', gateway.config.image) +
50+
container.new('observatorium-api', api.config.image) +
5151
container.withArgs([
5252
'--web.listen=0.0.0.0:8080',
53-
'--metrics.ui.endpoint=' + gateway.config.uiEndpoint,
54-
'--metrics.read.endpoint=' + gateway.config.readEndpoint,
55-
'--metrics.write.endpoint=' + gateway.config.writeEndpoint,
53+
'--metrics.ui.endpoint=' + api.config.uiEndpoint,
54+
'--metrics.read.endpoint=' + api.config.readEndpoint,
55+
'--metrics.write.endpoint=' + api.config.writeEndpoint,
5656
'--log.level=warn',
5757
]) +
5858
container.withPorts(
@@ -61,36 +61,36 @@ local k = import 'ksonnet/ksonnet.beta.4/k.libsonnet';
6161
container.mixin.livenessProbe +
6262
container.mixin.livenessProbe.withPeriodSeconds(30) +
6363
container.mixin.livenessProbe.withFailureThreshold(8) +
64-
container.mixin.livenessProbe.httpGet.withPort(gateway.service.spec.ports[0].port) +
64+
container.mixin.livenessProbe.httpGet.withPort(api.service.spec.ports[0].port) +
6565
container.mixin.livenessProbe.httpGet.withScheme('HTTP') +
6666
container.mixin.livenessProbe.httpGet.withPath('/-/healthy') +
6767
container.mixin.readinessProbe +
6868
container.mixin.readinessProbe.withPeriodSeconds(5) +
6969
container.mixin.readinessProbe.withFailureThreshold(20) +
70-
container.mixin.readinessProbe.httpGet.withPort(gateway.service.spec.ports[0].port) +
70+
container.mixin.readinessProbe.httpGet.withPort(api.service.spec.ports[0].port) +
7171
container.mixin.readinessProbe.httpGet.withScheme('HTTP') +
7272
container.mixin.readinessProbe.httpGet.withPath('/-/ready');
7373

74-
deployment.new(gateway.config.name, gateway.config.replicas, c, gateway.config.commonLabels) +
75-
deployment.mixin.metadata.withNamespace(gateway.config.namespace) +
76-
deployment.mixin.metadata.withLabels(gateway.config.commonLabels) +
77-
deployment.mixin.spec.selector.withMatchLabels(gateway.config.podLabelSelector) +
74+
deployment.new(api.config.name, api.config.replicas, c, api.config.commonLabels) +
75+
deployment.mixin.metadata.withNamespace(api.config.namespace) +
76+
deployment.mixin.metadata.withLabels(api.config.commonLabels) +
77+
deployment.mixin.spec.selector.withMatchLabels(api.config.podLabelSelector) +
7878
deployment.mixin.spec.strategy.rollingUpdate.withMaxSurge(0) +
7979
deployment.mixin.spec.strategy.rollingUpdate.withMaxUnavailable(1),
8080

8181
withServiceMonitor:: {
82-
local gateway = self,
82+
local api = self,
8383

8484
serviceMonitor: {
8585
apiVersion: 'monitoring.coreos.com/v1',
8686
kind: 'ServiceMonitor',
8787
metadata+: {
88-
name: gateway.config.name,
89-
namespace: gateway.config.namespace,
88+
name: api.config.name,
89+
namespace: api.config.namespace,
9090
},
9191
spec: {
9292
selector: {
93-
matchLabels: gateway.config.commonLabels,
93+
matchLabels: api.config.commonLabels,
9494
},
9595
endpoints: [
9696
{ port: 'http' },
@@ -100,7 +100,7 @@ local k = import 'ksonnet/ksonnet.beta.4/k.libsonnet';
100100
},
101101

102102
withResources:: {
103-
local gateway = self,
103+
local api = self,
104104

105105
config+:: {
106106
resources: error 'must provide resources',
@@ -111,8 +111,8 @@ local k = import 'ksonnet/ksonnet.beta.4/k.libsonnet';
111111
template+: {
112112
spec+: {
113113
containers: [
114-
if c.name == 'observatorium-api-gateway' then c {
115-
resources: gateway.config.resources,
114+
if c.name == 'observatorium-api' then c {
115+
resources: api.config.resources,
116116
} else c
117117
for c in super.containers
118118
],
@@ -123,7 +123,7 @@ local k = import 'ksonnet/ksonnet.beta.4/k.libsonnet';
123123
},
124124

125125
withTLS:: {
126-
local gateway = self,
126+
local api = self,
127127

128128
config+:: {
129129
tls: {
@@ -139,12 +139,12 @@ local k = import 'ksonnet/ksonnet.beta.4/k.libsonnet';
139139
template+: {
140140
spec+: {
141141
containers: [
142-
if c.name == 'observatorium-api-gateway' then c {
142+
if c.name == 'observatorium-api' then c {
143143
args+: [
144-
'--tls-cert-file=' + gateway.config.tls.certFile,
145-
'--tls-private-key-file=' + gateway.config.tls.privateKeyFile,
146-
'--tls-client-ca-file=' + gateway.config.tls.clientCAFile,
147-
'--tls-reload-interval=' + gateway.config.tls.reloadInterval,
144+
'--tls-cert-file=' + api.config.tls.certFile,
145+
'--tls-private-key-file=' + api.config.tls.privateKeyFile,
146+
'--tls-client-ca-file=' + api.config.tls.clientCAFile,
147+
'--tls-reload-interval=' + api.config.tls.reloadInterval,
148148
],
149149
} else c
150150
for c in super.containers

Diff for: ‎jsonnet/main.jsonnet

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
local gateway = (import 'lib/observatorium-api.libsonnet') {
1+
local api = (import 'lib/observatorium-api.libsonnet') {
22
config+:: {
33
local cfg = self,
4-
name: 'observatorium-api-gateway',
4+
name: 'observatorium-api',
55
namespace: 'observatorium',
66
version: 'master-2020-01-28-e009b4a',
77
image: 'quay.io/observatorium/observatorium:' + cfg.version,
@@ -12,7 +12,7 @@ local gateway = (import 'lib/observatorium-api.libsonnet') {
1212
},
1313
};
1414

15-
local gatewayWithTLS = gateway + gateway.withTLS {
15+
local apiWithTLS = api + api.withTLS {
1616
config+:: {
1717
tls+: {
1818
certFile: './tmp/certs/server.pem',
@@ -22,5 +22,5 @@ local gatewayWithTLS = gateway + gateway.withTLS {
2222
},
2323
};
2424

25-
{ [name]: gateway[name] for name in std.objectFields(gateway) } +
26-
{ ['%s-with-tls' % name]: gatewayWithTLS[name] for name in std.objectFields(gateway) }
25+
{ [name]: api[name] for name in std.objectFields(api) } +
26+
{ ['%s-with-tls' % name]: apiWithTLS[name] for name in std.objectFields(api) }

Diff for: ‎test/load.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ plot() {
101101
--storage.tsdb.path="$(mktemp -d)"
102102
) &
103103

104-
usage="$(basename "$0") [-h] [-r n] [-c n] [-m n] [-q n] [-o csv|gnuplot] -- program to test synthetic load on observatorium gateway and report results.
104+
usage="$(basename "$0") [-h] [-r n] [-c n] [-m n] [-q n] [-o csv|gnuplot] -- program to test synthetic load on observatorium api and report results.
105105
106106
where:
107107
-h show this help text

0 commit comments

Comments
 (0)