com.sitewhere.microservice.multitenant.MultitenantMicroservice Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sitewhere-microservice Show documentation
SiteWhere Microservice Components Library
The newest version!
/**
 * Copyright © 2014-2021 The SiteWhere Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.sitewhere.microservice.multitenant;

import com.fasterxml.jackson.databind.JsonNode;
import com.sitewhere.microservice.configuration.ConfigurableMicroservice;
import com.sitewhere.microservice.configuration.TenantEngineConfigurationMonitor;
import com.sitewhere.microservice.lifecycle.CompositeLifecycleStep;
import com.sitewhere.spi.SiteWhereException;
import com.sitewhere.spi.microservice.IFunctionIdentifier;
import com.sitewhere.spi.microservice.IMicroserviceConfiguration;
import com.sitewhere.spi.microservice.configuration.IScriptSpecUpdates;
import com.sitewhere.spi.microservice.configuration.IScriptVersionSpecUpdates;
import com.sitewhere.spi.microservice.configuration.ITenantEngineConfigurationMonitor;
import com.sitewhere.spi.microservice.lifecycle.ICompositeLifecycleStep;
import com.sitewhere.spi.microservice.lifecycle.ILifecycleProgressMonitor;
import com.sitewhere.spi.microservice.lifecycle.LifecycleStatus;
import com.sitewhere.spi.microservice.multitenant.IMicroserviceTenantEngine;
import com.sitewhere.spi.microservice.multitenant.IMultitenantMicroservice;
import com.sitewhere.spi.microservice.multitenant.ITenantEngineConfiguration;
import com.sitewhere.spi.microservice.multitenant.ITenantEngineManager;
import com.sitewhere.spi.microservice.multitenant.TenantEngineNotAvailableException;

import io.fabric8.kubernetes.client.informers.SharedInformerFactory;
import io.sitewhere.k8s.crd.ResourceLabels;
import io.sitewhere.k8s.crd.exception.SiteWhereK8sException;
import io.sitewhere.k8s.crd.instance.SiteWhereInstance;
import io.sitewhere.k8s.crd.microservice.SiteWhereMicroservice;
import io.sitewhere.k8s.crd.tenant.SiteWhereTenant;
import io.sitewhere.k8s.crd.tenant.engine.SiteWhereTenantEngine;
import io.sitewhere.k8s.crd.tenant.scripting.SiteWhereScript;
import io.sitewhere.k8s.crd.tenant.scripting.version.SiteWhereScriptVersion;

/**
 * Microservice that contains engines for multiple tenants.
 */
public abstract class MultitenantMicroservice>
	extends ConfigurableMicroservice implements IMultitenantMicroservice {

    /** Tenant engine configuration monitor */
    private ITenantEngineConfigurationMonitor tenantEngineConfigurationMonitor;

    /** Tenant engine manager */
    private ITenantEngineManager tenantEngineManager = new TenantEngineManager<>();

    /*
     * (non-Javadoc)
     * 
     * @see com.sitewhere.microservice.configuration.ConfigurableMicroservice#
     * initialize(com.sitewhere.spi.server.lifecycle.ILifecycleProgressMonitor)
     */
    @Override
    public void initialize(ILifecycleProgressMonitor monitor) throws SiteWhereException {
	super.initialize(monitor);

	// Create step that will start components.
	ICompositeLifecycleStep init = new CompositeLifecycleStep("Initialize " + getName());

	// Initialize tenant engine manager.
	init.addInitializeStep(this, getTenantEngineManager(), true);

	// Execute initialization steps.
	init.execute(monitor);
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * com.sitewhere.server.lifecycle.LifecycleComponent#start(com.sitewhere.spi
     * .server.lifecycle.ILifecycleProgressMonitor)
     */
    @Override
    public void start(ILifecycleProgressMonitor monitor) throws SiteWhereException {
	super.start(monitor);

	// Create step that will start components.
	ICompositeLifecycleStep start = new CompositeLifecycleStep("Start " + getName());

	// Start tenant engine manager.
	start.addStartStep(this, getTenantEngineManager(), true);

	// Execute startup steps.
	start.execute(monitor);
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * com.sitewhere.server.lifecycle.LifecycleComponent#stop(com.sitewhere.spi.
     * server.lifecycle.ILifecycleProgressMonitor)
     */
    @Override
    public void stop(ILifecycleProgressMonitor monitor) throws SiteWhereException {
	super.stop(monitor);

	// Create step that will stop components.
	ICompositeLifecycleStep stop = new CompositeLifecycleStep("Stop " + getName());

	// Stop tenant engine manager.
	stop.addStopStep(this, getTenantEngineManager());

	// Execute shutdown steps.
	stop.execute(monitor);
    }

    /*
     * @see com.sitewhere.microservice.configuration.ConfigurableMicroservice#
     * handleInstanceUpdated(io.sitewhere.k8s.crd.instance.SiteWhereInstance)
     */
    @Override
    protected void handleInstanceUpdated(SiteWhereInstance instance) throws SiteWhereException {
	super.handleInstanceUpdated(instance);
	if (getTenantEngineManager() != null
		&& getTenantEngineManager().getLifecycleStatus() == LifecycleStatus.Started) {
	    getLogger().info("Instance configuration updated. Restarting all tenant engines.");
	    getTenantEngineManager().restartAllTenantEngines();
	} else {
	    getLogger().info(
		    "Instance configuration updated but tenant engine manager not started yet. Skipping restart.");
	}
    }

    /*
     * @see com.sitewhere.microservice.configuration.ConfigurableMicroservice#
     * createKubernetesResourceControllers(io.fabric8.kubernetes.client.informers.
     * SharedInformerFactory)
     */
    @Override
    public void createKubernetesResourceControllers(SharedInformerFactory informers) throws SiteWhereException {
	super.createKubernetesResourceControllers(informers);

	// Add shared informer for instance configuration monitoring.
	this.tenantEngineConfigurationMonitor = new TenantEngineConfigurationMonitor(getIdentifier(),
		getKubernetesClient(), informers);
	getTenantEngineConfigurationMonitor().getListeners().add(getTenantEngineManager());
	getTenantEngineConfigurationMonitor().start();
    }

    /*
     * @see com.sitewhere.spi.microservice.multitenant.IMultitenantMicroservice#
     * getTenantEngineByToken(java.lang.String)
     */
    @Override
    public T getTenantEngineByToken(String token) throws SiteWhereException {
	return getTenantEngineManager().getTenantEngineByToken(token);
    }

    /*
     * @see com.sitewhere.spi.microservice.multitenant.IMultitenantMicroservice#
     * assureTenantEngineAvailable(java.lang.String)
     */
    @Override
    public T assureTenantEngineAvailable(String token) throws TenantEngineNotAvailableException {
	return getTenantEngineManager().assureTenantEngineAvailable(token);
    }

    /*
     * @see com.sitewhere.spi.microservice.multitenant.IMultitenantMicroservice#
     * getTenantEngineConfiguration(io.sitewhere.k8s.crd.tenant.SiteWhereTenant,
     * io.sitewhere.k8s.crd.microservice.SiteWhereMicroservice)
     */
    @Override
    public SiteWhereTenantEngine getTenantEngineConfiguration(SiteWhereTenant tenant,
	    SiteWhereMicroservice microservice) throws SiteWhereException {
	try {
	    return getSiteWhereKubernetesClient().getTenantEngine(microservice, tenant);
	} catch (SiteWhereK8sException e) {
	    throw new SiteWhereException(e);
	}
    }

    /*
     * @see com.sitewhere.spi.microservice.multitenant.IMultitenantMicroservice#
     * setTenantEngineConfiguration(io.sitewhere.k8s.crd.tenant.SiteWhereTenant,
     * io.sitewhere.k8s.crd.microservice.SiteWhereMicroservice,
     * com.fasterxml.jackson.databind.JsonNode)
     */
    @Override
    public SiteWhereTenantEngine setTenantEngineConfiguration(SiteWhereTenant tenant,
	    SiteWhereMicroservice microservice, JsonNode configuration) throws SiteWhereException {
	SiteWhereTenantEngine tenantEngine = getTenantEngineConfiguration(tenant, microservice);
	if (tenantEngine == null) {
	    throw new SiteWhereException(
		    String.format("Unable to find tenant engine for tenant/microservice combination. %s %s",
			    tenant.getMetadata().getName(), microservice.getMetadata().getName()));
	}
	tenantEngine.getSpec().setConfiguration(configuration);
	return getSiteWhereKubernetesClient().getTenantEngines().createOrReplace(tenantEngine);
    }

    /**
     * Get tenant engine associated with script.
     * 
     * @param script
     * @return
     * @throws SiteWhereException
     */
    protected T getScriptTenantEngine(SiteWhereScript script) throws SiteWhereException {
	String tenant = script.getMetadata().getLabels().get(ResourceLabels.LABEL_SITEWHERE_TENANT);
	if (tenant == null) {
	    throw new SiteWhereException("Script did not provide a tenant id label.");
	}
	return getTenantEngineManager().getTenantEngineByToken(tenant);
    }

    /*
     * @see
     * com.sitewhere.spi.microservice.configuration.IScriptConfigurationListener#
     * onScriptAdded(io.sitewhere.k8s.crd.tenant.scripting.SiteWhereScript)
     */
    @Override
    public void onScriptAdded(SiteWhereScript script) {
	try {
	    SiteWhereScriptVersion version = getMicroservice().getSiteWhereKubernetesClient().getActiveVersion(script);
	    if (version != null) {
		T engine = getScriptTenantEngine(script);
		if (engine != null) {
		    engine.getScriptManager().addScript(script, version);
		    getLogger().info("Resource create processed for script: %s", script.getMetadata().getName());
		}
	    } else {
		getLogger().info("Active version not found for added script: %s", script.getMetadata().getName());
	    }
	} catch (SiteWhereException e) {
	    getLogger().error(String.format("Unable to process added script: %s", script.getMetadata().getName()), e);
	}
    }

    /*
     * @see
     * com.sitewhere.spi.microservice.configuration.IScriptConfigurationListener#
     * onScriptUpdated(io.sitewhere.k8s.crd.tenant.scripting.SiteWhereScript,
     * com.sitewhere.spi.microservice.configuration.IScriptSpecUpdates)
     */
    @Override
    public void onScriptUpdated(SiteWhereScript script, IScriptSpecUpdates updates) {
	try {
	    SiteWhereScriptVersion version = getMicroservice().getSiteWhereKubernetesClient().getActiveVersion(script);
	    if (version != null) {
		T engine = getScriptTenantEngine(script);
		if (engine != null) {
		    engine.getScriptManager().addScript(script, version);
		    getLogger().info("Resource update processed for script: %s", script.getMetadata().getName());
		}
	    } else {
		getLogger().info("Active version not found for updated script: %s", script.getMetadata().getName());
	    }
	} catch (SiteWhereException e) {
	    getLogger().error(String.format("Unable to process updated script: %s", script.getMetadata().getName()), e);
	}
    }

    /*
     * @see
     * com.sitewhere.spi.microservice.configuration.IScriptConfigurationListener#
     * onScriptDeleted(io.sitewhere.k8s.crd.tenant.scripting.SiteWhereScript)
     */
    @Override
    public void onScriptDeleted(SiteWhereScript script) {
	try {
	    T engine = getScriptTenantEngine(script);
	    if (engine != null) {
		engine.getScriptManager().removeScript(script);
	    }
	    getLogger().info("Resource delete processed for script: %s", script.getMetadata().getName());
	} catch (SiteWhereException e) {
	    getLogger().error(String.format("Unable to process deleted script: %s", script.getMetadata().getName()), e);
	}
    }

    /*
     * @see com.sitewhere.spi.microservice.configuration.
     * IScriptVersionConfigurationListener#onScriptVersionAdded(io.sitewhere.k8s.crd
     * .tenant.scripting.version.SiteWhereScriptVersion)
     */
    @Override
    public void onScriptVersionAdded(SiteWhereScriptVersion version) {
	try {
	    SiteWhereScript script = getMicroservice().getSiteWhereKubernetesClient().getParentScript(version);
	    T engine = getScriptTenantEngine(script);
	    if (engine != null) {
		String activeVersion = script.getSpec().getActiveVersion();
		if (activeVersion != null && version.getMetadata().getName().equals(activeVersion)) {
		    engine.getScriptManager().addScript(script, version);
		    getLogger().info(
			    String.format("Active script version '%s' was added.", version.getMetadata().getName()));
		}
	    }
	} catch (SiteWhereK8sException e) {
	    getLogger().error(String.format("K8s error processing added version: %s", version.getMetadata().getName()),
		    e);
	} catch (SiteWhereException e) {
	    getLogger().error(String.format("Error processing added version: %s", version.getMetadata().getName()), e);
	}
    }

    /*
     * @see com.sitewhere.spi.microservice.configuration.
     * IScriptVersionConfigurationListener#onScriptVersionUpdated(io.sitewhere.k8s.
     * crd.tenant.scripting.version.SiteWhereScriptVersion,
     * com.sitewhere.spi.microservice.configuration.IScriptVersionSpecUpdates)
     */
    @Override
    public void onScriptVersionUpdated(SiteWhereScriptVersion version, IScriptVersionSpecUpdates updates) {
	try {
	    SiteWhereScript script = getMicroservice().getSiteWhereKubernetesClient().getParentScript(version);
	    T engine = getScriptTenantEngine(script);
	    if (engine != null) {
		String activeVersion = script.getSpec().getActiveVersion();
		if (activeVersion != null && version.getMetadata().getName().equals(activeVersion)) {
		    engine.getScriptManager().addScript(script, version);
		    getLogger().info(
			    String.format("Active script version '%s' was updated.", version.getMetadata().getName()));
		}
	    }
	} catch (SiteWhereK8sException e) {
	    getLogger().error(
		    String.format("K8s error processing updated version: %s", version.getMetadata().getName()), e);
	} catch (SiteWhereException e) {
	    getLogger().error(String.format("Error processing updated version: %s", version.getMetadata().getName()),
		    e);
	}
    }

    /*
     * @see com.sitewhere.spi.microservice.configuration.
     * IScriptVersionConfigurationListener#onScriptVersionDeleted(io.sitewhere.k8s.
     * crd.tenant.scripting.version.SiteWhereScriptVersion)
     */
    @Override
    public void onScriptVersionDeleted(SiteWhereScriptVersion version) {
	try {
	    SiteWhereScript script = getMicroservice().getSiteWhereKubernetesClient().getParentScript(version);
	    T engine = getScriptTenantEngine(script);
	    if (engine != null) {
		String activeVersion = script.getSpec().getActiveVersion();
		if (activeVersion != null && version.getMetadata().getName().equals(activeVersion)) {
		    engine.getScriptManager().removeScript(script);
		    getLogger().info(
			    String.format("Active script version '%s' was deleted.", version.getMetadata().getName()));
		}
	    }
	} catch (SiteWhereK8sException e) {
	    getLogger().error(
		    String.format("K8s error processing deleted version: %s", version.getMetadata().getName()), e);
	} catch (SiteWhereException e) {
	    getLogger().error(String.format("Error processing deleted version: %s", version.getMetadata().getName()),
		    e);
	}
    }

    /*
     * @see com.sitewhere.spi.microservice.multitenant.IMultitenantMicroservice#
     * getTenantEngineConfigurationMonitor()
     */
    @Override
    public ITenantEngineConfigurationMonitor getTenantEngineConfigurationMonitor() {
	return tenantEngineConfigurationMonitor;
    }

    /*
     * @see com.sitewhere.spi.microservice.multitenant.IMultitenantMicroservice#
     * getTenantEngineManager()
     */
    @Override
    public ITenantEngineManager getTenantEngineManager() {
	return tenantEngineManager;
    }
}