Github on Layer5 Documentation

Connect GitHub

Mon, 01 Jan 0001 00:00:00 +0000

The GitHub integration connects your GitHub account to Layer5 Cloud through the Layer5 GitHub App. Once connected, you can browse the repositories you granted, pick Kubernetes manifests, Helm charts, Docker Compose files, and Meshery designs, and import each file as a design. The same connection can also install a pull-request snapshot workflow in your repositories.

Use it when your infrastructure already lives in Git and you want those files on the canvas without downloading and uploading them one at a time. For a one-off file, import it directly instead.

Visualize Pull Requests with Kanvas Snapshot

Mon, 01 Jan 0001 00:00:00 +0000

Kanvas Snapshot posts a picture of your infrastructure as a comment on each GitHub pull request. Reviewers see which components a Kubernetes manifest, Docker Compose file, or Helm chart defines, and how they connect, before they read the YAML. The comment updates on every push to the pull request.

The snapshot runs in a GitHub Actions workflow on GitHub-hosted runners. It never touches your cluster. For how a snapshot is built and what it can and cannot do, see Kanvas Snapshot.

Integrations

Mon, 01 Jan 0001 00:00:00 +0000

Integrations connect Layer5 Cloud to systems outside it. Today that means GitHub, for importing infrastructure files and posting pull-request snapshots, and the infrastructure connections that Meshery Servers register. This page lists every integration the product offers, what each one does, and where to configure it, so you can tell quickly whether Layer5 Cloud can connect to the tool you use.

Integration matrix 🔗

Integration	What it does	Where to start
GitHub (Layer5 GitHub App)	Reads the repositories you grant, imports Kubernetes manifests, Helm charts, Docker Compose files, and Meshery designs as private designs, and can commit a snapshot workflow to a repository.	Connect GitHub
GitHub Actions (Kanvas Snapshot)	Posts a picture of your infrastructure on every pull request.	Use GitHub Actions
Meshery Server	Registers each Meshery Server as a connection, so you can see and manage the servers in your organization.	Listed under Meshery on the Integrations tab.
Kubernetes	Lists the clusters your Meshery Servers manage, so you can assign them to environments.	Manage Environments
Prometheus	Lists Prometheus connections that Meshery Servers report.	Listed under Prometheus on the Integrations tab.

Meshery Servers register Meshery, Kubernetes, and Prometheus connections. Layer5 Cloud has no setup wizard for them. The Integrations tab shows what the servers in your organization registered, and you assign those connections to environments to decide which teams reach them.

Kanvas Snapshot

Mon, 01 Jan 0001 00:00:00 +0000

Kanvas Snapshot turns an infrastructure-as-code file into a picture of the design it describes. It runs as a GitHub workflow or as a Helm plugin, not in the Kanvas canvas, so reviewers see the shape of a change (which components exist and how they connect) without reading YAML or opening Kanvas.

A snapshot is standalone. It never connects to your cluster and never deploys anything. It reads the file you point it at, builds a design from it, and renders that design to an image.