pl.allegro.tech.servicemesh.envoycontrol.ControlPlane.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of envoy-control-core Show documentation
Show all versions of envoy-control-core Show documentation
Production-ready Control Plane for Service Mesh based on Envoy Proxy.
package pl.allegro.tech.servicemesh.envoycontrol
import io.envoyproxy.controlplane.cache.NodeGroup
import io.envoyproxy.controlplane.cache.SnapshotCache
import io.envoyproxy.controlplane.cache.v3.Snapshot
import io.envoyproxy.controlplane.server.DefaultExecutorGroup
import io.envoyproxy.controlplane.server.ExecutorGroup
import io.envoyproxy.controlplane.server.V3DiscoveryServer
import io.envoyproxy.controlplane.server.callback.SnapshotCollectingCallback
import io.grpc.Server
import io.grpc.netty.NettyServerBuilder
import io.micrometer.core.instrument.MeterRegistry
import io.micrometer.core.instrument.Tags
import io.micrometer.core.instrument.binder.jvm.ExecutorServiceMetrics
import io.netty.channel.nio.NioEventLoopGroup
import io.netty.channel.socket.nio.NioServerSocketChannel
import pl.allegro.tech.servicemesh.envoycontrol.groups.Group
import pl.allegro.tech.servicemesh.envoycontrol.groups.GroupChangeWatcher
import pl.allegro.tech.servicemesh.envoycontrol.groups.MetadataNodeGroup
import pl.allegro.tech.servicemesh.envoycontrol.groups.NodeMetadataValidator
import pl.allegro.tech.servicemesh.envoycontrol.server.CachedProtoResourcesSerializer
import pl.allegro.tech.servicemesh.envoycontrol.server.ExecutorProperties
import pl.allegro.tech.servicemesh.envoycontrol.server.ExecutorType
import pl.allegro.tech.servicemesh.envoycontrol.server.callbacks.CompositeDiscoveryServerCallbacks
import pl.allegro.tech.servicemesh.envoycontrol.server.callbacks.LoggingDiscoveryServerCallbacks
import pl.allegro.tech.servicemesh.envoycontrol.server.callbacks.MetricsDiscoveryServerCallbacks
import pl.allegro.tech.servicemesh.envoycontrol.services.MultiClusterState
import pl.allegro.tech.servicemesh.envoycontrol.snapshot.EnvoySnapshotFactory
import pl.allegro.tech.servicemesh.envoycontrol.snapshot.NoopSnapshotChangeAuditor
import pl.allegro.tech.servicemesh.envoycontrol.snapshot.SnapshotChangeAuditor
import pl.allegro.tech.servicemesh.envoycontrol.snapshot.SnapshotUpdater
import pl.allegro.tech.servicemesh.envoycontrol.snapshot.SnapshotsVersions
import pl.allegro.tech.servicemesh.envoycontrol.snapshot.resource.clusters.EnvoyClustersFactory
import pl.allegro.tech.servicemesh.envoycontrol.snapshot.resource.endpoints.EnvoyEndpointsFactory
import pl.allegro.tech.servicemesh.envoycontrol.snapshot.resource.listeners.EnvoyListenersFactory
import pl.allegro.tech.servicemesh.envoycontrol.snapshot.resource.listeners.filters.EnvoyHttpFilters
import pl.allegro.tech.servicemesh.envoycontrol.snapshot.resource.routes.EnvoyEgressRoutesFactory
import pl.allegro.tech.servicemesh.envoycontrol.snapshot.resource.routes.EnvoyIngressRoutesFactory
import pl.allegro.tech.servicemesh.envoycontrol.snapshot.resource.routes.ServiceTagMetadataGenerator
import pl.allegro.tech.servicemesh.envoycontrol.utils.DirectScheduler
import pl.allegro.tech.servicemesh.envoycontrol.utils.ParallelScheduler
import pl.allegro.tech.servicemesh.envoycontrol.utils.ParallelizableScheduler
import pl.allegro.tech.servicemesh.envoycontrol.v3.SimpleCache
import reactor.core.Disposable
import reactor.core.publisher.Flux
import reactor.core.scheduler.Schedulers
import java.time.Clock
import java.util.concurrent.BlockingQueue
import java.util.concurrent.Executor
import java.util.concurrent.ExecutorService
import java.util.concurrent.Executors
import java.util.concurrent.LinkedBlockingQueue
import java.util.concurrent.ThreadFactory
import java.util.concurrent.ThreadPoolExecutor
import java.util.concurrent.TimeUnit
import java.util.concurrent.atomic.AtomicInteger
class ControlPlane private constructor(
val grpcServer: Server,
val snapshotUpdater: SnapshotUpdater,
val nodeGroup: NodeGroup,
val cache: SnapshotCache,
private val changes: Flux
) : AutoCloseable {
private var servicesDisposable: Disposable? = null
companion object {
fun builder(
properties: EnvoyControlProperties,
meterRegistry: MeterRegistry
) = ControlPlaneBuilder(properties, meterRegistry)
}
fun start() {
servicesDisposable = snapshotUpdater
.start(changes)
.subscribe()
grpcServer.start()
}
override fun close() {
servicesDisposable?.dispose()
grpcServer.shutdownNow()
grpcServer.awaitTermination()
}
class ControlPlaneBuilder(
val properties: EnvoyControlProperties,
val meterRegistry: MeterRegistry
) {
var grpcServerExecutor: Executor? = null
var nioEventLoopExecutor: Executor? = null
var nioBossEventLoopExecutor: Executor? = null
var executorGroup: ExecutorGroup? = null
var globalSnapshotExecutor: Executor? = null
var globalSnapshotAuditExecutor: Executor? = null
var groupSnapshotParallelExecutorSupplier: () -> Executor? = { null }
var metrics: EnvoyControlMetrics = DefaultEnvoyControlMetrics(meterRegistry = meterRegistry)
var envoyHttpFilters: EnvoyHttpFilters = EnvoyHttpFilters.emptyFilters
var snapshotChangeAuditor: SnapshotChangeAuditor = NoopSnapshotChangeAuditor
var nodeGroup: NodeGroup = MetadataNodeGroup(
properties = properties.envoy.snapshot
)
var currentZone: String = "local"
fun build(changes: Flux): ControlPlane {
if (grpcServerExecutor == null) {
grpcServerExecutor = buildThreadPoolExecutor()
}
if (nioEventLoopExecutor == null) {
// unbounded executor - netty will only use configured number of threads
// (by nioEventLoopThreadCount property or default netty value: * 2)
nioEventLoopExecutor = newMeteredCachedThreadPool("grpc-worker-event-loop")
}
if (nioBossEventLoopExecutor == null) {
// unbounded executor - netty will only use configured number of threads
// (by nioEventLoopThreadCount property or default netty value: * 2)
nioBossEventLoopExecutor = newMeteredCachedThreadPool("grpc-boss-event-loop")
}
if (executorGroup == null) {
executorGroup = buildExecutorGroup()
}
if (globalSnapshotExecutor == null) {
globalSnapshotExecutor = newMeteredFixedThreadPool(
"snapshot-update",
properties.server.globalSnapshotUpdatePoolSize
)
}
if (globalSnapshotAuditExecutor == null) {
globalSnapshotAuditExecutor = newMeteredFixedThreadPool(
"snapshot-audit",
properties.server.globalSnapshotAuditPoolSize
)
}
val groupSnapshotProperties = properties.server.groupSnapshotUpdateScheduler
val groupSnapshotScheduler = buildGroupSnapshotScheduler(groupSnapshotProperties)
val cache = SimpleCache(nodeGroup, properties.envoy.snapshot.shouldSendMissingEndpoints)
val groupChangeWatcher = GroupChangeWatcher(cache, metrics, meterRegistry)
val meteredConnectionsCallbacks = MetricsDiscoveryServerCallbacks(meterRegistry)
val loggingDiscoveryServerCallbacks = LoggingDiscoveryServerCallbacks(
properties.server.logFullRequest,
properties.server.logFullResponse
)
val compositeDiscoveryServerCallbacksV3 = listOf(
CompositeDiscoveryServerCallbacks(
meterRegistry,
buildSnapshotCollectingCallback(cache),
loggingDiscoveryServerCallbacks,
meteredConnectionsCallbacks,
NodeMetadataValidator(properties.envoy.snapshot)
)
)
val cachedProtoResourcesSerializer = CachedProtoResourcesSerializer(
meterRegistry,
properties.server.reportProtobufCacheMetrics
)
val snapshotsVersions = SnapshotsVersions()
val snapshotProperties = properties.envoy.snapshot
val envoySnapshotFactory = EnvoySnapshotFactory(
ingressRoutesFactory = EnvoyIngressRoutesFactory(snapshotProperties, envoyHttpFilters, currentZone),
egressRoutesFactory = EnvoyEgressRoutesFactory(snapshotProperties),
clustersFactory = EnvoyClustersFactory(snapshotProperties, currentZone),
endpointsFactory = EnvoyEndpointsFactory(
snapshotProperties,
ServiceTagMetadataGenerator(snapshotProperties.routing.serviceTags),
currentZone
),
listenersFactory = EnvoyListenersFactory(
snapshotProperties,
envoyHttpFilters
),
// Remember when LDS change we have to send RDS again
snapshotsVersions = snapshotsVersions,
properties = snapshotProperties,
meterRegistry = meterRegistry
)
val grpcServerBuilder = grpcServerBuilder()
grpcServerBuilder.withEnvoyServices(
createV3Server(
compositeDiscoveryServerCallbacksV3,
groupChangeWatcher,
cachedProtoResourcesSerializer
)
)
return ControlPlane(
grpcServerBuilder.build(),
SnapshotUpdater(
cache,
snapshotChangeAuditor,
properties.envoy.snapshot,
envoySnapshotFactory,
Schedulers.fromExecutor(globalSnapshotExecutor),
Schedulers.fromExecutor(globalSnapshotAuditExecutor),
groupSnapshotScheduler,
groupChangeWatcher.onGroupAdded(),
meterRegistry,
snapshotsVersions
),
nodeGroup,
cache,
changes
)
}
private fun grpcServerBuilder(): NettyServerBuilder = NettyServerBuilder.forPort(properties.server.port)
.workerEventLoopGroup(
NioEventLoopGroup(
properties.server.nioEventLoopThreadCount,
nioEventLoopExecutor
)
)
.bossEventLoopGroup(
NioEventLoopGroup(
properties.server.nioBossEventLoopThreadCount,
nioBossEventLoopExecutor
)
)
.channelType(NioServerSocketChannel::class.java)
.executor(grpcServerExecutor)
.keepAliveTime(properties.server.netty.keepAliveTime.toMillis(), TimeUnit.MILLISECONDS)
.permitKeepAliveTime(properties.server.netty.permitKeepAliveTime.toMillis(), TimeUnit.MILLISECONDS)
.permitKeepAliveWithoutCalls(properties.server.netty.permitKeepAliveWithoutCalls)
private fun createV3Server(
compositeDiscoveryServerCallbacks: List,
groupChangeWatcher: GroupChangeWatcher,
cachedProtoResourcesSerializer: CachedProtoResourcesSerializer
): V3DiscoveryServer {
return V3DiscoveryServer(
compositeDiscoveryServerCallbacks,
groupChangeWatcher,
executorGroup,
cachedProtoResourcesSerializer
)
}
private fun buildSnapshotCollectingCallback(
cache: SimpleCache
): SnapshotCollectingCallback {
val cleanupProperties = properties.server.snapshotCleanup
return SnapshotCollectingCallback(
cache,
nodeGroup,
Clock.systemDefaultZone(),
emptySet(),
cleanupProperties.collectAfterMillis.toMillis(),
cleanupProperties.collectionIntervalMillis.toMillis()
)
}
private fun buildGroupSnapshotScheduler(groupSnapshotProperties: ExecutorProperties): ParallelizableScheduler {
return when (groupSnapshotProperties.type) {
ExecutorType.DIRECT -> DirectScheduler
ExecutorType.PARALLEL -> ParallelScheduler(
scheduler = Schedulers.fromExecutor(
groupSnapshotParallelExecutorSupplier()
?: newMeteredFixedThreadPool(
"group-snapshot",
groupSnapshotProperties.parallelPoolSize
)
),
parallelism = groupSnapshotProperties.parallelPoolSize
)
}
}
private fun buildExecutorGroup(): ExecutorGroup {
return when (properties.server.executorGroup.type) {
ExecutorType.DIRECT -> DefaultExecutorGroup()
ExecutorType.PARALLEL -> {
// TODO(https://github.com/allegro/envoy-control/issues/103) this implementation of parallel
// executor group is invalid, because it may lead to sending XDS responses out of order for
// given DiscoveryRequestStreamObserver. We should switch to multiple, single-threaded
// ThreadPoolExecutors. More info in linked task.
val executor = newMeteredFixedThreadPool(
"discovery-responses-executor",
properties.server.executorGroup.parallelPoolSize
)
ExecutorGroup { executor }
}
}
}
private fun buildThreadPoolExecutor(): ThreadPoolExecutor {
return newMeteredThreadPoolExecutor(
properties.server.serverPoolSize,
properties.server.serverPoolSize,
properties.server.serverPoolKeepAlive.toMillis(),
LinkedBlockingQueue(),
"grpc-server-worker"
)
}
fun withNodeGroup(nodeGroup: NodeGroup): ControlPlaneBuilder {
this.nodeGroup = nodeGroup
return this
}
fun withGrpcServerExecutor(executor: Executor): ControlPlaneBuilder {
grpcServerExecutor = executor
return this
}
fun withNioEventLoopExecutor(executor: Executor): ControlPlaneBuilder {
nioEventLoopExecutor = executor
return this
}
fun withNioBossEventLoopExecutor(executor: Executor): ControlPlaneBuilder {
nioBossEventLoopExecutor = executor
return this
}
fun withExecutorGroup(executor: ExecutorGroup): ControlPlaneBuilder {
executorGroup = executor
return this
}
fun withGlobalSnapshotExecutor(executor: Executor): ControlPlaneBuilder {
globalSnapshotExecutor = executor
return this
}
fun withGlobalSnapshotAuditExecutor(executor: Executor): ControlPlaneBuilder {
globalSnapshotAuditExecutor = executor
return this
}
fun withSnapshotChangeAuditor(snapshotChangeAuditor: SnapshotChangeAuditor): ControlPlaneBuilder {
if (properties.envoy.snapshot.shouldAuditGlobalSnapshot) {
this.snapshotChangeAuditor = snapshotChangeAuditor
} else {
this.snapshotChangeAuditor = NoopSnapshotChangeAuditor
}
return this
}
fun withGroupSnapshotParallelExecutor(executorSupplier: () -> Executor): ControlPlaneBuilder {
groupSnapshotParallelExecutorSupplier = executorSupplier
return this
}
fun withMetrics(metrics: EnvoyControlMetrics): ControlPlaneBuilder {
this.metrics = metrics
return this
}
fun withEnvoyHttpFilters(envoyHttpFilters: EnvoyHttpFilters): ControlPlaneBuilder {
this.envoyHttpFilters = envoyHttpFilters
return this
}
fun withCurrentZone(zone: String): ControlPlaneBuilder {
this.currentZone = zone
return this
}
private fun NettyServerBuilder.withEnvoyServices(discoveryServer: V3DiscoveryServer): NettyServerBuilder {
return this.addService(discoveryServer.aggregatedDiscoveryServiceImpl)
.addService(discoveryServer.clusterDiscoveryServiceImpl)
.addService(discoveryServer.endpointDiscoveryServiceImpl)
.addService(discoveryServer.listenerDiscoveryServiceImpl)
.addService(discoveryServer.routeDiscoveryServiceImpl)
}
private class ThreadNamingThreadFactory(val threadNamePrefix: String) : ThreadFactory {
private val counter = AtomicInteger()
override fun newThread(r: Runnable) = Thread(r, "$threadNamePrefix-${counter.getAndIncrement()}")
}
private fun newMeteredThreadPoolExecutor(
corePoolSize: Int,
maximumPoolSize: Int,
keepAliveTimeMillis: Long,
workQueue: BlockingQueue,
poolExecutorName: String
): ThreadPoolExecutor {
val threadPoolExecutor = ThreadPoolExecutor(
corePoolSize,
maximumPoolSize,
keepAliveTimeMillis,
TimeUnit.MILLISECONDS,
workQueue,
ThreadNamingThreadFactory(poolExecutorName)
)
meterExecutor(threadPoolExecutor, poolExecutorName)
return threadPoolExecutor
}
private fun newMeteredFixedThreadPool(executorServiceName: String, poolSize: Int): ExecutorService {
val executor = Executors.newFixedThreadPool(poolSize, ThreadNamingThreadFactory(executorServiceName))
meterExecutor(executor, executorServiceName)
return executor
}
private fun newMeteredCachedThreadPool(executorServiceName: String): ExecutorService {
val executor = Executors.newCachedThreadPool(ThreadNamingThreadFactory(executorServiceName))
meterExecutor(executor, executorServiceName)
return executor
}
private fun meterExecutor(executor: ExecutorService, executorServiceName: String) {
ExecutorServiceMetrics(
executor,
executorServiceName,
Tags.of("executor", executorServiceName)
)
.bindTo(meterRegistry)
}
}
}