Skip to content

Commit

Permalink
Merge pull request #369 from layer5io/leecalcote/chore/change-to-kanvas
Browse files Browse the repository at this point in the history
[Chore] Change to Kanvas name
  • Loading branch information
leecalcote committed Sep 10, 2024
2 parents 4795aa0 + 475bf8a commit eb49cd7
Show file tree
Hide file tree
Showing 109 changed files with 164 additions and 164 deletions.
4 changes: 2 additions & 2 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
component/cloud-docs:
- "content/en/cloud/**/*"

component/meshmap-docs:
- "content/en/meshmap/**/*"
component/kanvas-docs:
- "content/en/kanvas/**/*"
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,19 +75,19 @@ Meshery Workspaces serve as a virtual space for your team-based work.

### Tutorials

- **MeshMap Snapshots**: Connect MeshMap to your GitHub repo and see changes pull request-to-pull request.
- **Kanvas Snapshots**: Connect Kanvas to your GitHub repo and see changes pull request-to-pull request.
- **Sharing a Workspace**: Learn how to control access to workspaces and their resources.
- **Recognizing User and Contributor Milestones**: Showcasing user and contributor achievements

### Self-Hosted

Keep your MeshMap designs internal to your workplace. Get remote support from Layer5 when you need it.
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.

## Meshmap Docs
## Kanvas Docs

### Getting Started with Designs

Expand All @@ -98,8 +98,8 @@ Low-level ReST API reference for extending Layer5 Cloud.

### Exploring Designer

- **Reviewing Designs:** Learn how to leverage comments in MeshMap’s Designer Mode to enhance collaboration and streamline design reviews.
- **Whiteboarding:** Whiteboarding and Freestyle Drawing inside meshmap
- **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
Expand All @@ -112,15 +112,15 @@ Visualizer mode is for operating your Kubernetes clusters and cloud native infra

### Core Tasks

- **Whiteboarding:** MeshMap Designer supports freestyle design, meaning that you can customize the appearance and layout of your diagrams without any constraints.
- **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 Meshmap to enhance your designing experience.
- **Keyboard Shortcuts:** Learn the keyboard shortcuts for Kanvas to enhance your designing experience.

- **Troubleshooting MeshMap:** Learn to Troubleshoot the MeshMap
- **Troubleshooting Kanvas:** Learn to Troubleshoot the Kanvas

### Contribution Guidelines

Expand Down
8 changes: 4 additions & 4 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ onmouseover="changeImage('layer5', 'images/logos/layer5-light.svg')" onmouseout=
Cloud Docs
<i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
<a class="btn btn-lg btn-primary me-3 mb-4 l5btn" href="/meshmap" aria-label="MeshMap Docs"
onmouseover="changeImage('Meshmap', 'images/logos/meshmap-light.svg')" onmouseout="restoreImage('Meshmap', 'images/logos/meshmap-alt.svg')">
<img id="Meshmap" src="images/logos/meshmap-alt.svg" alt="Layer5 MeshMap Docs Logo" />
MeshMap Docs
<a class="btn btn-lg btn-primary me-3 mb-4 l5btn" href="/kanvas" aria-label="Kanvas Docs"
onmouseover="changeImage('Kanvas', 'images/logos/kanvas-light.svg')" onmouseout="restoreImage('Kanvas', 'images/logos/kanvas-alt.svg')">
<img id="Kanvas" src="images/logos/kanvas-alt.svg" alt="Layer5 Kanvas Docs Logo" />
Kanvas Docs
<i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
<a class="btn btn-lg btn-primary me-3 mb-4 l5btn" href="https://docs.meshery.io" aria-label="Meshery Docs"
Expand Down
8 changes: 4 additions & 4 deletions content/en/cloud/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ cascade:
**Meshery** ([docs](https://docs.meshery.io)) is a cloud native manager that enables the design and management of Kubernetes-based infrastructure and applications. It is an extensible developer platform that seamlessly integrates with all CNCF projects, and various monitoring, CI/CD, and security tools.
</div></div>

<div style="display: flex; align-items: flex-start; margin-top:15px;"><div class="logo-container">{{< svg name="meshmap" >}}</div>
<div style="display: flex; align-items: flex-start; margin-top:15px;"><div class="logo-container">{{< svg name="kanvas" >}}</div>

<div style="flex: 1;">

**MeshMap** ([docs](/meshmap)) provides a visual interface that allows users to create and edit Kubernetes manifests, charts and pipelines, as well as monitor the performance and health of their clusters. MeshMap aims to simplify the complexity of Kubernetes and make it accessible to more users, similar to how Figma democratized design tools for web and mobile applications.
**Kanvas** ([docs](/kanvas)) provides a visual interface that allows users to create and edit Kubernetes manifests, charts and pipelines, as well as monitor the performance and health of their clusters. Kanvas aims to simplify the complexity of Kubernetes and make it accessible to more users, similar to how Figma democratized design tools for web and mobile applications.
</div></div>
</div>
{{% /pageinfo %}}
Expand All @@ -50,7 +50,7 @@ Please follow this space for updates!
{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/gohugoio/hugo" %}}
We do a [Pull Request](https://github.com/gohugoio/hugo/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}
{{% blocks/feature icon="./featured-background.png" title="MeshMap" url="/meshmap" %}}
**MeshMap** provides a visual interface that allows users to create and edit Kubernetes manifests, charts and pipelines, as well as monitor the performance and health of their clusters. MeshMap aims to simplify the complexity of Kubernetes and make it accessible to more users, similar to how Figma democratized design tools for web and mobile applications.
{{% blocks/feature icon="./featured-background.png" title="Kanvas" url="/kanvas" %}}
**Kanvas** provides a visual interface that allows users to create and edit Kubernetes manifests, charts and pipelines, as well as monitor the performance and health of their clusters. Kanvas aims to simplify the complexity of Kubernetes and make it accessible to more users, similar to how Figma democratized design tools for web and mobile applications.
{{% /blocks/feature %}}
{{< /blocks/section >}} -->
2 changes: 1 addition & 1 deletion content/en/cloud/catalog/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The design catalog can be accessed from the _Layer5 Cloud_ catalog page at [Laye

{{< alert title="Note" >}}

Designs can be imported, exported, versioned, forked, merged, snapshotted, published, shared, embedded, templatized, and more. Learn more about [Designs](/meshmap/getting-started/)
Designs can be imported, exported, versioned, forked, merged, snapshotted, published, shared, embedded, templatized, and more. Learn more about [Designs](/kanvas/getting-started/)

{{< /alert >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ weight: 2
4. For detailed information just click on it.
5. Simply click the green clone button.
6. Now you have it. Navigate to [Meshery Playground](https://playground.meshery.io/)
7. Go to the MeshMap and you will see your cloned template here. If you con't see it just reload the page.
7. Go to the Kanvas and you will see your cloned template here. If you con't see it just reload the page.

You can also publish your own design as a template.
4 changes: 2 additions & 2 deletions content/en/cloud/getting-started/github-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You can commence the integration process from the "**Extensions Page in Meshery*
### Access Integrations Page from the Meshery Extensions Page

1. Go to [Extensions](https://playground.meshery.io/extensions).
1. Click on **Enable** for **GitHub Action: MeshMap Snapshot**.
1. Click on **Enable** for **GitHub Action: Kanvas Snapshot**.
1. You will be redirected to the Integrations page.

![Extensions](/cloud/getting-started/images/github/extensions.png)
Expand Down Expand Up @@ -128,7 +128,7 @@ These next steps are optional. By enabling snapshots, you can choose a design fr

- **Assigns Permissions**: Provides necessary permissions for reading actions, writing content, handling security events, statuses, and pull requests.

- **Captures Snapshots**: Uses the MeshMap-Snapshot action to capture snapshots of your infrastructure based on the specified application_type (e.g. Kubernetes Manifest, Docker Compose, Helm Chart).
- **Captures Snapshots**: Uses the Kanvas-Snapshot action to capture snapshots of your infrastructure based on the specified application_type (e.g. Kubernetes Manifest, Docker Compose, Helm Chart).

With the workflow active in your repository, you can now visualize changes to your infrastructure directly in your pull requests, making it easier to track and review updates on designs.

Expand Down
26 changes: 13 additions & 13 deletions content/en/cloud/github-actions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,48 +3,48 @@ title: GitHub Actions
description: GitHub Actions with Meshery automates the synchronization of Git repositories and visually validates pull requests for efficient development.
weight: 20
categories: [Workspaces]
tags: [gitops, github-actions, meshmap]
tags: [gitops, github-actions, kanvas]
---
Meshery GitHub Actions enhance your operational workflow by integrating git version control and the management of your infrastructure. Meshery GitHub Actions are design to integrate into your existing pipelines.

## Meshery Github Actions

1. [MeshMap Snapshot](#meshmap-snapshot-github-action)
1. [Kanvas Snapshot](#kanvas-snapshot-github-action)
2. [Performance Testing with Meshery](https://docs.meshery.io/guides/gitops-with-meshery)
3. Archived: [Service Mesh Interface Conformance with Meshery](https://github.com/marketplace/actions/service-mesh-interface-conformance-with-meshery)

This methodology automates the synchronization of your actual infrastructure state with the desired state defined in your Git repository. Meshery enables GitOps by offering a comprehensive view of your infrastructure, allowing you to verify workload designs and Kubernetes cluster configurations before merging pull requests.

## MeshMap Snapshot GitHub Action
## Kanvas Snapshot GitHub Action

Meshery introduces the MeshMap Snapshot GitHub Actions, a tool that allows you to visualize changes in your infrastructure directly in your pull requests. With MeshMap Snapshot, you can:
Meshery introduces the Kanvas Snapshot GitHub Actions, a tool that allows you to visualize changes in your infrastructure directly in your pull requests. With Kanvas Snapshot, you can:

- See your deployment changes pull request-to-pull request.
- Get snapshots of your infrastructure directly in your pull requests.

[See action in GitHub Marketplace](https://github.com/marketplace/actions/meshmap-snapshot)
[See action in GitHub Marketplace](https://github.com/marketplace/actions/kanvas-snapshot)

### Configuring MeshMap Snapshots
### Configuring Kanvas Snapshots

MeshMap serves as a fundamental component, providing visual insights into infrastructure changes and facilitating the synchronization between the actual and desired states. Ensure that you have proper access to MeshMap to leverage its capabilities for effective GitOps implementation.
Kanvas serves as a fundamental component, providing visual insights into infrastructure changes and facilitating the synchronization between the actual and desired states. Ensure that you have proper access to Kanvas to leverage its capabilities for effective GitOps implementation.

#### Step 1: Get access to MeshMap
#### Step 1: Get access to Kanvas

To integrate Snapshots into your GitHub pull requests, confirm that your user account has MeshMap access. To do so, sign into your Layer5 Cloud account and look forIf your user account doesn't have access, [simply request access](https://meshery.layer5.io/account/subscriptions) to MeshMap.
To integrate Snapshots into your GitHub pull requests, confirm that your user account has Kanvas access. To do so, sign into your Layer5 Cloud account and look forIf your user account doesn't have access, [simply request access](https://meshery.layer5.io/account/subscriptions) to Kanvas.

#### Step 2: Enable MeshMap Snapshot Action
#### Step 2: Enable Kanvas Snapshot Action

1. Choose to enable the MeshMap Snapshot action for all repositories in your GitHub account or for specific repositories.
1. Choose to enable the Kanvas Snapshot action for all repositories in your GitHub account or for specific repositories.
1. Authorize the Meshery GitHub App.
1. Copy the Secret token. This token is used to authenticate Meshery with your Layer5 Cloud account.
1. Once authorized, Meshery will automatically create a pull request workflow for your repository. To disable the workflow, simply delete the `.github/workflows/meshmap-snapshot.yml` file from your repository.
1. Once authorized, Meshery will automatically create a pull request workflow for your repository. To disable the workflow, simply delete the `.github/workflows/kanvas-snapshot.yml` file from your repository.
1. Specify the path within your Git repository where the application configurations are stored. This ensures Meshery knows where to find and visuzlie the desired state of your infrastructure.

{{%pageinfo%}}
The Meshery GitHub App requires authorization to interact with your repositories. If you would like to use your GitHub user's personal access token, instead, [please let us know](https://meshery.layer5.io/support). {{%/pageinfo%}}


## Customizing Snapshot Workflow Triggers in MeshMap Snapshot
## Customizing Snapshot Workflow Triggers in Kanvas Snapshot

You can configure your workflows to run when specific activity on GitHub happens, at a scheduled time, or when an event outside of GitHub occurs.

Expand Down
4 changes: 2 additions & 2 deletions content/en/cloud/identity/users/notification-preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ Layer5 Cloud offers a range of user-configurable preferences that allows you to

- **Workspace Activity:** You can choose to be notified about:
- Changes to Designs
- Comments on Your Designs: Check this box to receive notifications for all new comments on your designs. Unchecking this box will disable all comment notifications. If you prefer to keep this box checked but wish to stop receiving notifications for a specific comment thread, you can directly mute notifications for that thread in the comment modal. You can [learn more about this feature](https://docs.layer5.io/meshmap/designer/comments/#mute-comment-notifications).
- Comments on Your Designs: Check this box to receive notifications for all new comments on your designs. Unchecking this box will disable all comment notifications. If you prefer to keep this box checked but wish to stop receiving notifications for a specific comment thread, you can directly mute notifications for that thread in the comment modal. You can [learn more about this feature](https://docs.layer5.io/kanvas/designer/comments/#mute-comment-notifications).
- Deployment in environments
- Membership Changes: team membership, user account creation/deletion
- Participating, @mentions in comments: [Learn more](https://docs.layer5.io/meshmap/designer/comments/#mute-comment-notifications)
- Participating, @mentions in comments: [Learn more](https://docs.layer5.io/kanvas/designer/comments/#mute-comment-notifications)
- Weekly summary

5. Click **Save Preferences**
Expand Down
2 changes: 1 addition & 1 deletion content/en/cloud/security/sessions.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ A session is created each time a user successfully authenticates. See all active

To use a session, sign into your Layer5 Cloud user account, thereby creating a new session. Your session's token will automatically be stored in your web browser using a cookie. To use that same session, simply use the same browser until the session expires. You can have multiple sessions active concurrently, whether on the same device or different device. Each session receives it's own authentication token and expiry time.

In this way, it is possible to use your same account to collaborate between different sessions that you have established. For example, you may use those two different sessions to open up the same MeshMap design and you will find that your avatar shows up twice in the design (along with your mouse cursor). You can use this to collaborate with yourself or with others. We recommend collaborating with others, though.
In this way, it is possible to use your same account to collaborate between different sessions that you have established. For example, you may use those two different sessions to open up the same Kanvas design and you will find that your avatar shows up twice in the design (along with your mouse cursor). You can use this to collaborate with yourself or with others. We recommend collaborating with others, though.

## Revoking sessions

Expand Down
2 changes: 1 addition & 1 deletion content/en/cloud/self-hosted/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Self-Hosted
weight: 10
categories: [Self-Hosted]
description: >
Keep your MeshMap designs internal to your workplace. Get remote support from Layer5 when you need it.
Keep your Kanvas designs internal to your workplace. Get remote support from Layer5 when you need it.
---

<img class="image-right-no-shadow" src="images/self-hosted.svg" width="40%" />
Expand Down
6 changes: 3 additions & 3 deletions content/en/cloud/self-hosted/customizing-webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Add your custom webhook URLs to the **.env** file by modifying the existing vari
# Triggers when a user fills the help and support form.
WEBHOOK_HELP_AND_SUPPORT="https://your-custom-webhook-url.com/help-support"

# Webhook to send an email notification to the user when they receive a Meshmap entitlement
WEBHOOK_MESHMAP_ENTITLEMENT="https://your-custom-webhook-url.com/meshmap-entitlement"
# Webhook to send an email notification to the user when they receive a Kanvas entitlement
WEBHOOK_MESHMAP_ENTITLEMENT="https://your-custom-webhook-url.com/kanvas-entitlement"

# Webhook to send an update email upon signup request approval or denial.
WEBHOOK_SIGNUP_REQUEST="https://your-custom-webhook-url.com/signup-request"
Expand All @@ -47,4 +47,4 @@ After updating the **.env** file, apply the changes to your Layer5 Cloud install

### Step 5: Testing the Webhooks

Once the configuration is applied, test the webhooks to ensure they are functioning correctly. You can trigger each webhook by performing the associated actions (e.g., filling out the help and support form, triggering a Meshmap entitlement, or processing a signup request).
Once the configuration is applied, test the webhooks to ensure they are functioning correctly. You can trigger each webhook by performing the associated actions (e.g., filling out the help and support form, triggering a Kanvas entitlement, or processing a signup request).
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Characteristics of the peer-to-peer communication include:
- Very little server load
- Not suited for a large amount of collaborators on a single document (each peer is connected to each other)

![meshmap-collaboration-networking](../images/meshmap-collaboration-networking.svg "image-center-no-shadow")
![kanvas-collaboration-networking](../images/kanvas-collaboration-networking.svg "image-center-no-shadow")

### Default Configuration

Expand Down
8 changes: 4 additions & 4 deletions content/en/cloud/tutorials/gitops-snapshots.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: MeshMap Snapshots
title: Kanvas Snapshots
description: >
Connect MeshMap to your GitHub repo and see changes pull request-to-pull request.
Connect Kanvas to your GitHub repo and see changes pull request-to-pull request.
category: GitOps
weight: 4
---


MeshMap Snapshots offer visual insights in every pull request. Verify your workload designs and Kubernetes cluster configurations prior to accepting and merging pull requests.
Kanvas Snapshots offer visual insights in every pull request. Verify your workload designs and Kubernetes cluster configurations prior to accepting and merging pull requests.

## Meshery GitHub App

In order to generate snapshots and apply them as screenshots in comments on your pool request, you need to authorize the measure you get home app to access. Your infrastructure is code. This is done by creating a GitHub connection in Layer5 Cloud.

View the Meshery GitHub App in the [GitHub Marketplace](https://github.com/marketplace/actions/meshmap-snapshot).
View the Meshery GitHub App in the [GitHub Marketplace](https://github.com/marketplace/actions/kanvas-snapshot).

## Enabling and Configuring Snapshots

Expand Down
Loading

0 comments on commit eb49cd7

Please sign in to comment.