Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/istio-ecosystem/admiral

Admiral provides automatic configuration generation, syncing and service discovery for multicluster Istio service mesh
https://github.com/istio-ecosystem/admiral

admiral automation clusters configuration istio k8s microservices multi-cluster multicluster service-discovery service-mesh

Last synced: 2 months ago
JSON representation

Admiral provides automatic configuration generation, syncing and service discovery for multicluster Istio service mesh

Host: GitHub
URL: https://github.com/istio-ecosystem/admiral
Owner: istio-ecosystem
License: apache-2.0
Created: 2019-08-22T17:53:04.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-02-22T05:49:29.000Z (4 months ago)
Last Synced: 2024-04-15T01:56:53.650Z (2 months ago)
Topics: admiral, automation, clusters, configuration, istio, k8s, microservices, multi-cluster, multicluster, service-discovery, service-mesh
Language: Go
Homepage:
Size: 28.8 MB
Stars: 556
Watchers: 30
Forks: 76
Open Issues: 19
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Lists

awesome-cloud-native - admiral - Admiral provides automatic configuration generation, syncing and service discovery for multicluster Istio service mesh. (Service Registry and Discovery)
Self-Hosting-Guide - Admiral
awesome-istio - Admiral - Admiral provides automatic configuration generation, syncing and service discovery for multicluster Istio service mesh. (Configuration)
awesome-stars - admiral - ecosystem | 567 | (Go)
awesome-stars - admiral - ecosystem | 567 | (Go)

README

        


  



[![CircleCI](https://circleci.com/gh/istio-ecosystem/admiral/tree/master.svg?style=svg)](https://circleci.com/gh/istio-ecosystem/admiral/tree/master) [![codecov](https://codecov.io/gh/istio-ecosystem/admiral/branch/master/graph/badge.svg)](https://codecov.io/gh/istio-ecosystem/admiral)

**Admiral provides automatic configuration and service discovery for multicluster Istio service mesh**

Istio has a very robust set of multi-cluster capabilities.  Managing this configuration across multiple clusters at scale is challenging.  Admiral takes an opinionated view on this configuration and provides automatic provisioning and syncing across clusters.

Admiral defines two custom resources, the [Dependency](./docs/Architecture.md#dependency) and [GlobalTrafficPolicy](./docs/Architecture.md#global-traffic-policy), which are used to configure ServiceEntries, VirtualServices, and DestinationRules on each cluster for each cross-cluster service. This removes the complexity for developers and mesh operators.

![alt text](./docs/diagrams/admiral.svg)

[Admiral Demo](https://www.youtube.com/watch?v=cwQpt1t287c)

## [Docs](./docs/Index.md)

## Who uses Admiral?

Organizations below are **officially** using Admiral. Please send a PR with your organization name if you are using Admiral.

* [Intuit](https://www.intuit.com/)

## Blogs and Presentations

* [Multicluster Istio configuration and service discovery using Admiral](https://istio.io/blog/2020/multi-cluster-mesh-automation/)

* [Stitching a Service Mesh Across Hundreds of Discrete Networks](https://www.youtube.com/watch?v=EWyNbBn1vns)

* [Scaling Service Mesh to an Enterprise Microservices Ecosystem](https://apiworld2019aidevworld2019.sched.com/event/SLIQ/pro-talk-scaling-service-mesh-to-an-enterprise-microservices-ecosystem)

## Collaboration and Communication

[Admiral Slack Channel](https://istio.slack.com/archives/CT3F18T08) - `Note:` This channel is under Istio slack org, please fill out this [form](https://docs.google.com/forms/d/e/1FAIpQLSfdsupDfOWBtNVvVvXED6ULxtR4UIsYGCH_cQcRr0VcG1ZqQQ/viewform) to get access to Istio slack.

## Contributing

Refer to [Contributing doc](./CONTRIBUTING.md)

## Release Cadence

Details can be found [here](./docs/Processes.md)

## Admiral sequence diagram

```mermaid

sequenceDiagram

		autonumber 1

    Service/VirtualService Handler->>+Rollout/Deployment Handler: Add/Update/Delete events

    loop

			autonumber 1

			GTP Handler->>GTP Handler: Add/Update/Delete events

    end

		autonumber 1

    GTP Handler ->> ServiceEntry Handler: Add/Update

		loop

				autonumber 1

        Rollout/Deployment Handler->>Rollout/Deployment Handler: Add/Delete events of rollout/deployment

    end

		autonumber 1

		Rollout/Deployment Handler->>ServiceEntry Handler: Add/Update

    autonumber 2

    ServiceEntry Handler->>RemoteControllers: Fetch All Cluster Controllers

		rect rgb(255, 255, 220)

	    loop

		    ServiceEntry Handler->>K8sAPI 1..N: For each cluster, get corresponding service object

				K8sAPI 1..N-->>ServiceEntry Handler: Continue if service does not exist for deployment/rollout

				K8sAPI 1..N-->>ServiceEntry Handler: Build list of source services

	    end

		end

	  rect rgb(255, 255, 220)

	    loop

				ServiceEntry Handler->>K8sAPI 1..N: Derive SE from each service in the list

				ServiceEntry Handler->>GTP Cache: Derive DR from GTP

			  rect rgb(204, 255, 204)

			    loop

				    ServiceEntry Handler->>K8sAPI 1..N: Add/Update SE/DR in source clusters

					end

		    end

	    end

		end

    ServiceEntry Handler->>DependencyCache: Fetch dependent clusters

		rect rgb(204, 255, 204)

	    loop

				ServiceEntry Handler->>K8sAPI 1..N: Add/Update SE/DR in dependent clusters

			end

		end

```