This is a collection of examples for using Spring Boot in OpenShift 3.
There is a makefile for the installation. We can easy doing the installation following the steps:
make login-openshift OPENSHIFT_URL=${OPENSHIFT_URL} OPENSHIFT_USER=${OPENSHIFT_USER}
From this command you'll obtain a TOKEN.
- Project creation:
export OS_PROJECT=<PROJECT_NAME>
make make create-project OS_PROJECT=${OS_PROJECT}
- Add permissions
Some of the running pods need access to the Kubernetes api, we add permissions to the default user.
make add-permissions OS_PROJECT=${OS_PROJECT}
- Set the application
This command will set all the setup in the project, creating deployment configs, routes, builds, etc.
make set-app OS_PROJECT=${OS_PROJECT} \
OPENSHIFT_URL=${OPENSHIFT_URL} \
OPENSHIFT_TOKEN=${OPENSHIFT_TOKEN} \
REDEPLOY_OPENSHIFT_TEMPLATE=${REDEPLOY_OPENSHIFT_TEMPLATE} \
GIT_SOURCE_URL=${GIT_SOURCE_URL}
Params:
- REDEPLOY_OPENSHIFT_TEMPLATE: if it is true will delete every component and will recreate it.
- GIT_SOURCE_URL: For example this git repo (https://github.com/jgpelaez/openshift-springboot-samples.git)
All the example components use the same templates stored in ./devops/openshift/templates
The installation of the components is done with ansible, with the playbook ./devops/ansible/app-openshift-deploy.yml
The project openshift-sb-config-server is an spring boot server. It is configure to use a local file in ./src/main/resources/configserver.yml
- Access:
http://[FQDN]/configserver/default
Eureka service discovery
- Access:
http://[FQDN]/
Is a simple spring boot microservice.
- Access:
http://[FQDN]/api/test
Is a simple spring boot microservice.
In this sample we check some features:
First we need to add to the pom.xml
<dependency>
<groupId>io.fabric8</groupId>
<artifactId>spring-cloud-kubernetes-core</artifactId>
<version>${spring-cloud-starter-kubernetes.version}</version>
</dependency>
<dependency>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>okhttp</artifactId>
<version>${okhttp.version}</version>
</dependency>
This will activate the automatic configuration from a ConfigMap and Secrets, both had be called with the same name of the deployment config. Creation example:
apiVersion: v1
kind: Template
labels:
template: app-springboot-cm-template
metadata:
name: app-springboot-cm
objects:
- apiVersion: v1
kind: ConfigMap
metadata:
name: ${APP_NAME}-${SERVICE_NAME}
data:
application.properties: |-
bean.message=Hello World!
another.property=value
parameters:
- name: SERVICE_NAME
value: eureka
- name: APP_NAME
value: openshift-sb
apiVersion: v1
kind: Template
labels:
template: app-springboot-cm-template
metadata:
name: app-springboot-cm
objects:
- apiVersion: v1
kind: Secret
metadata:
name: ${APP_NAME}-${SERVICE_NAME}
type: Opaque
data:
secret.username: bXl1c2VyCg==
secret.password: bXlwYXNzd29yZA==
parameters:
- name: SERVICE_NAME
value: eureka
- name: APP_NAME
value: openshift-sb
Then we need to add the configuration to the bootstrap.yml
spring:
application:
name: <service_name>
cloud:
config:
uri: ${CONFIG_SERVER_URI:http://localhost:8888/configserver/}
kubernetes:
discovery:
enabled: ${SPRING_CLOUD_KUBERNETES_DISCOVERY_ENABLED:true}
secrets:
enabled: ${SPRING_CLOUD_KUBERNETES_DISCOVERY_ENABLED:true}
enableApi: ${SPRING_CLOUD_KUBERNETES_DISCOVERY_ENABLED:true}
reload:
enabled: ${SPRING_CLOUD_KUBERNETES_DISCOVERY_ENABLED:true}
<aside class="notice">
!!!This configuration should be added in the bootstrap, it doesn't work in the application.yml or in the config server (that has been checked)
</aside>
The reload parameter will enable to modify dynamically the configuration, in the logs of the application we can see the values, and if we modify the config maps will be changes.
Finally we can read the properties in the applicacion.yml:
store:
dbUser: ${secret.username:test}
Or in the code:
@Configuration
@ConfigurationProperties(prefix = "secret")
public class MySecrets {
private String password;
private String username;
public String getPassword() {
return password;
}
- Access:
http://[FQDN]/api/stores
The Zuul services gateway. We provide an extra future to use the ZUUL api gateway using the Kubernetes API for do the service discovery. In the ZuulServerDiscoveryConfig we override the default DiscoveryClientRouteLocator:
@Bean
public DiscoveryClientRouteLocator routeLocator() {
return new CustomDiscoveryClientRouteLocator(this.serviceDiscovery, this.config, this.server.getServletPrefix(),
this.discovery, this.zuulProperties, this.serviceRouteMapper);
}
And the CustomDiscoveryClientRouteLocator, obtains from the Kubernetes api all services for the namespace, and all are saved in the routes for zuul:
@Override
protected LinkedHashMap<String, ZuulRoute> locateRoutes() {
LinkedHashMap<String, ZuulRoute> routes = super.locateRoutes();
if (!config.getUseEurekaServices()) {
for (String serviceId : serviceDiscovery.getServices()) {
String serviceName = serviceId;
if (config.getRemoveAppPrefix()) {
serviceName = serviceName.replaceAll(this.config.getAppPrefix(), "");
}
String path = "/" + config.getServicesPrefix() + "/" + serviceName + "/**";
CustomZuulRoute customZuulRoute = new CustomZuulRoute(config, serviceId, serviceName, serviceName,
path, null, null, true, false, null);
routes.put(path, customZuulRoute);
}
}
return routes;
}
The dynamic zuul can be configured in the application.yml (or the config server):
dynamiczuul:
# we can disable the kubernetes service discovery and use Eureka
useEurekaServices: false
# For local development
localServices: false
# Default services port( by now all services should be in the same port)
servicesPort: ${SERVICES_PORT:9000}
# Prefix for the url, for example: http://localhost:8765/services/openshift-sb-ms-store
servicesPrefix: services
# If we want the url's to remove a prefix, for example for using http://localhost:8765/services/ms-store
removeAppPrefix: false
appPrefix: openshift-sb-
# Custom routes, if we want to use a different name for a service, for example to use a blue green deployment
# can be specified here
customRoutes:
lg-ms-customersblue:
serviceId: lg-ms-customers
# Service black list, all services matching with the regexp servicesBlackList expressions will be banned
# http://www.vogella.com/tutorials/JavaRegularExpressions/article.html
servicesBlacklist:
- postgresql
- broker.*
- Testing it
http://[FQDN]/services/openshift-sb-ms-store/api/stores
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent