If you’re using Layer5 products or if you like the project, please ★ this repository to show your support! 🤩

About Layer5

Layer5's cloud native application and infrastructure management software enables engineers to expect more from their infrastructure. We embrace developer-defined infrastructure. We empower developers to change how they write applications, support operators in rethinking how they run modern infrastructure, and enable product owners to regain full-control over their product portfolio.

Contributions Welcome

✔️ Join any or all of the weekly meetings on community calendar.
✔️ Watch community meeting recordings.
✔️ Access the Community Drive by completing a community Member Form.
✔️ Discuss in the Community Forum.
✔️ Explore more in the Community Handbook.

Explore tutorials and documentation by product in the https://docs.layer5.io website; documentation and developer resources of Layer5 products. If you find a typo or you feel like you can improve the HTML, CSS, or JavaScript, we welcome contributions. Feel free to open issues or pull requests like any normal GitHub project, and we'll merge it in 🚀

Building the Documentation

Build Docs with Golang

If your local development environment has a supported version (v1.21.0+) of Golang installed, next you'll need to install extended Hugo version as it has necessary SCSS/SASS support. Find all the Hugo packages here:

Now to setup and run the site locally execute:

1. make setup
2. make site
3. visit http://localhost:1313

If you pull down new code from GitHub, you will occasionally need to run make setup again. Otherwise, there's no need to re-run make setup each time the site is run, you can just run make site to get it going and have it automatically reload as you make and save site edits.

Build Docs with Docker

Running the site locally is simple. Provided you have Docker installed, clone this repo, run make docker, and then visit http://localhost:1313.

[!IMPORTANT]
This requires Docker Desktop version 4.24 or later, or Docker Engine with Docker Compose version 2.22 or later.

Contribution Guidelines

--> See https://docs.layer5.io/contributing <-- for a detailed contribution guide.

Documentation Structure

The following is the high-level outline and information architecture for Layer5 documentation.

Goal: Offer comprehensive, organized, and accessible documentation for diverse audiences, from new users to expert contributors.

Target Audience:

• Personas: Beginners, developers, admins, operators, security specialists, contributors, users of all experience levels.
• Needs: Varied - learning fundamentals, managing tasks, understanding advanced concepts, contributing code.

Cloud Section: Information Architecture

Getting Started

• Creating an Account
• Creating your first Designs

Concepts

An overview of Layer5 Cloud concepts and their relationships to one another.

Identity

• Organizations: Organizations, Managing Organization Permissions
• Teams: Teams, Managing Teams Permissions
• Users: User Management, Managing User Permissions

Security

• Tokens: API Tokens are used to authenticate to Layer5 Cloud’s REST API.
• Keychains: Keychains are a collection of keys
• Keys: Keys are the atomic unit of access control
• Roles: Roles map permissions to users.

Catalog

The Cloud Catalog is a web-based, public catalog to facilitate easy sharing and discovery of common cloud native architectures and design patterns.

Workspaces

Workspaces serve as a virtual space for your team-based work.

Tutorials

• Kanvas Snapshots
• Sharing a Workspace
• Recognizing User and Contributor Milestones

Self-Hosted

Keep your Kanvas designs internal to your workplace. Get remote support from Layer5 when you need it.

Reference

Low-level ReST API reference for extending Layer5 Cloud.

Kanvas Section: Information Architecture

Getting Started with Designs

• Starting from a pattern: A Pattern is an entity that augments the operational behavior of a deployed instance of a Design.
• Creating Relationships: Relationships identify and facilitate genealogy between Components.
• Working with Components: Components represent entities in the ecosystem, exposing capabilities of the underlying platform.
• Starting from scratch: Emphasize the underlying system behavior for each action you take.

Exploring Designer

• Reviewing Designs: Learn how to leverage comments in Kanvas’s Designer Mode to enhance collaboration and streamline design reviews.
• Whiteboarding: Whiteboarding and Freestyle Drawing inside Kanvas
• Export Designs: How to export your designs for backup, sharing or offline use.

Working with Components

Designs are descriptive, declarative characterizations of how your Kubernetes infrastructure should be configured

Navigating Operator

Operator mode is for operating your Kubernetes clusters and cloud native infrastructure.

Core Tasks

• Whiteboarding: Kanvas Designer supports freestyle design, meaning that you can customize the appearance and layout of your diagrams without any constraints.
• Deploying Designs: Validating Designs, Undeploying Designs, Deploying Designs, Cloning a Design

Reference

• Keyboard Shortcuts: Learn the keyboard shortcuts for Kanvas to enhance your designing experience.
• Troubleshooting Kanvas: Learn to Troubleshoot the Kanvas

---

Our projects are community-driven and open to collaboration. 👍 Be sure to see the Layer5 Community Welcome Guide for a tour of resources available to you. You can also join our Slack to get involved.

Find your MeshMate

MeshMates are experienced Layer5 community members who will help you learn your way around, discover live projects and expand your community network. Become a Meshtee today!

Find out more on the Layer5 community.

 

✔️ Join any or all of the weekly meetings on Community calendar.
✔️ Watch community meeting recordings.
✔️ Access the Community Drive by completing a community Member Form.
✔️ Discuss in the Community Forum.
✔️ Explore more in the Community Handbook.

Not sure where to start? Grab an open issue with the help-wanted label.