Skip to content

Commit 41fa262

Browse files
committed
Rename Visualizer to Operator and update related documentation
Signed-off-by: Lee Calcote <[email protected]>
1 parent 103a723 commit 41fa262

21 files changed

+68
-62
lines changed

CONTRIBUTING.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,8 @@ This repository and site are available as open source under the terms of the [Ap
261261
### About Layer5
262262

263263
**Community First**
264-
<p>The <a href="https://layer5.io">Layer5</a> community represents the largest collection of service mesh projects and their maintainers in the world.</p>
264+
<p>The <a href="https://layer5.io">Layer5</a> community champions developer-defined infrastructure, giving engineers the power to reshape application delivery. We empower operators in reimagining how they manage modern infrastructure: collaboratively.
265+
</p>
265266

266267
**Open Source First**
267268
<p>Our projects establish industry standards and enable service developers, owners, and operators with repeatable patterns and best practices for managing all aspects of distributed services. Our shared commitment to the open source spirit push the Layer5 community and its projects forward.</p>

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,9 @@ Low-level ReST API reference for extending Layer5 Cloud.
114114

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

117-
### Navigating Visualizer
117+
### Navigating Operator
118118

119-
Visualizer mode is for operating your Kubernetes clusters and cloud native infrastructure.
119+
Operator mode is for operating your Kubernetes clusters and cloud native infrastructure.
120120

121121
### Core Tasks
122122

content/en/kanvas/_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ Choose your mode of operation for Kanvas.
6565
<p>Use context-aware relationships configure your infrastructure intuitively.</p>
6666
{{< /card >}}
6767
</a>
68-
<a href="../kanvas/visualizer/">
69-
{{< card header="Visualizer" >}}
70-
<a href="../kanvas/visualizer/">Visualizer</a> mode is for operating your Kubernetes clusters and cloud native infrastructure.
68+
<a href="../kanvas/operator/">
69+
{{< card header="Operator" >}}
70+
<a href="../kanvas/operator/">Operator</a> mode is for operating your Kubernetes clusters and cloud native infrastructure.
7171
<p>Bring all your Kubernetes clusters under a common management. Deploy designs, apply patterns, manage and operate your deployments and services in real-time.</p>
7272
<p>Interactively connect to pods and containers to debug and troubleshoot.</p>
7373
{{< /card >}}

content/en/kanvas/visualizer/_index.md content/en/kanvas/operator/_index.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
---
2-
title: Navigating Visualizer
2+
title: Navigating Operator
33
weight: 5
44
description: >
5-
Visualizer mode is for operating your Kubernetes clusters and cloud native infrastructure.
6-
categories: [Visualizer]
5+
Operator mode is for operating your Kubernetes clusters and cloud native infrastructure.
6+
categories: [Operator]
77
aliases:
8-
- /meshmap/visualizer
8+
- /meshmap/operator
99
---
1010

11-
Discover and examine your Kubernetes clusters and cloud native infrastructure using Visualizer mode.
11+
Discover and examine your Kubernetes clusters and cloud native infrastructure using Operator mode.
1212

1313
## Using Filters
1414

1515
Using filters you can select the Kubernetes resources you want to view. Apply one or more filters to narrow down the resources you want to view.
1616

1717
## Search and Select Specific Resources
1818

19-
Using the search bar, you can search for specific resources and select them. The selected resources are highlighted in the Visualizer canvas. Details of the selected resources are displayed in the right panel.
19+
Using the search bar, you can search for specific resources and select them. The selected resources are highlighted in the Operator canvas. Details of the selected resources are displayed in the right panel.
2020

21-
<!-- {{< figure src="images/visualizer-filters.png" link="images/visualizer-filters.png" width="100%" >}} -->
21+
<!-- {{< figure src="images/operator-filters.png" link="images/operator-filters.png" width="100%" >}} -->
2222

2323
## Connecting with Kubernetes Pods
2424

25-
Visualizer supports connecting to Kubernetes pods via the following methods.
25+
Operator supports connecting to Kubernetes pods via the following methods.
2626

2727
### Understanding Log Streamer
2828

Original file line numberDiff line numberDiff line change
@@ -1,59 +1,64 @@
11
---
2-
title: Views in Visualizer
2+
title: Views in Operator
33
weight: 5
44
description: >
5-
Learn about Views in Visualizer mode
6-
categories: [Visualizer]
7-
aliases:
8-
- /meshmap/visualizer/visualizer-views
5+
Learn about Views in Operator mode
6+
categories: [Operator]
97
---
108

11-
The Views tab is located on the right side of the screen just beside the Details tab in Kanvas Visualizer. It allows you to see all containers the present in your Kubernetes cluster. Think of views for Visualizer mode as you would design for the Designer mode.
9+
The Views tab is located on the right side of the screen just beside the Details tab in Kanvas Operator. It allows you to see all containers the present in your Kubernetes cluster. Think of views for Operator mode as you would design for the Designer mode.
10+
11+
![Operator Views](/kanvas/operator/images/Views.svg)
1212

13-
![Visualizer Views](/kanvas/visualizer/images/Views.svg)
1413
## Managing Views
15-
Here's what you can do with views in Visualizer:
14+
15+
Here's what you can do with views in Operator:
1616

1717
### 1. Save a view
18+
1819
To save a view, simply give your view a title in the Name field at the top of the canvas. Any changes made to the view will be automatically saved. Alternatively, click on the "Save as" button at the top of the canvas. A modal will pop up for you to give your view a name and save it.
1920

20-
![Save a view](/kanvas/visualizer/images/SaveView.png)
21+
![Save a view](/kanvas/operator/images/SaveView.png)
2122

2223
### 2. Set view visibility
23-
You can choose to set your views to be either public or private. When views are set as public, everyone within your workspace can access these views. Views set as private are visible only to the person who created the view, ie the owner.
2424

25-
![Set view visibility](/kanvas/visualizer/images/Visibility.png)
25+
You can choose to set your views to be either public or private. When views are set as public, everyone within your workspace can access these views. Views set as private are visible only to the person who created the view, ie the owner.
26+
27+
![Set view visibility](/kanvas/operator/images/Visibility.png)
2628

2729
### 3. Share a view
30+
2831
Sharing a view lets you collaborate with team members. In the share modal, you can add the user you want to share the view with. You can also set your view access as either public or private. When it's set to public, anyone with the link to the view can edit the view. When it's set to private, others can view but only the owner can edit.
2932
To share a view,
33+
3034
1. Click on the actions icon to the right of the view you want to share.
31-
32-
![Actions](/kanvas/visualizer/images/ActionsIcon.png)
33-
35+
36+
![Actions](/kanvas/operator/images/ActionsIcon.png)
37+
3438
2. You'll find a list of actions. Share is the third icon from the left
3539

36-
![Share a view](/kanvas/visualizer/images/ShareView.png)
37-
40+
![Share a view](/kanvas/operator/images/ShareView.png)
41+
3842
3. Click on the share icon to open up the share modal.
39-
40-
![Share a view](/kanvas/visualizer/images/ShareModal.PNG)
41-
43+
44+
![Share a view](/kanvas/operator/images/ShareModal.PNG)
45+
4246
4. Enter the name of the user you want to share a view with and set the view access.
43-
4447

4548
### 4. Delete a view
49+
4650
You can delete a view when you no longer have use of it. You can only delete a view that you created. Views created by others and made public cannot be deleted, except by the owner of that view.
4751

48-
![Delete a view](/kanvas/visualizer/images/DeleteView.png)
52+
![Delete a view](/kanvas/operator/images/DeleteView.png)
4953

5054
### 5. Export a view
55+
5156
To export a view, click on the export icon in the actions list. The view will be downloaded to your device in json format.
5257

53-
![Export a view](/kanvas/visualizer/images/ExportView2.png)
58+
![Export a view](/kanvas/operator/images/ExportView2.png)
5459

55-
5660
### 6. View info
61+
5762
View info shows you the owner of the design, the view visibility (whether it's set to public or private), the date the design was created and the date it was last modified. If you're the owner of the view, you'll also see an input field where you can add notes about the design.
5863

59-
![View Info](/kanvas/visualizer/images/ViewInfo.png)
64+
![View Info](/kanvas/operator/images/ViewInfo.png)

content/en/kanvas/reference/keyboard-shortcuts.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ As a designer in Kanvas, you can take advantage of various keyboard shortcuts to
2727

2828
These designer shortcuts are essential for a smooth and efficient design workflow within Kanvas.
2929

30-
### Visualizer Shortcuts
30+
### Operator Shortcuts
3131

32-
Kanvas's visualizer provides a set of keyboard shortcuts to enhance your experience when working with the visualized data. These shortcuts help you navigate, search, and manage the environment effectively:
32+
Kanvas's operator provides a set of keyboard shortcuts to enhance your experience when working with the visualized data. These shortcuts help you navigate, search, and manage the environment effectively:
3333

34-
- <button class="kbc-button kbc-button-xs">Ctrl</button> + <button class="kbc-button kbc-button-xs">Left-click</button> + <button class="kbc-button kbc-button-xs">Drag</button>: Create a selection box to select multiple nodes in Visualizer by dragging your mouse over an area.
34+
- <button class="kbc-button kbc-button-xs">Ctrl</button> + <button class="kbc-button kbc-button-xs">Left-click</button> + <button class="kbc-button kbc-button-xs">Drag</button>: Create a selection box to select multiple nodes in Operator by dragging your mouse over an area.
3535
- <button class="kbc-button kbc-button-xs">Ctrl</button> + <button class="kbc-button kbc-button-xs">Left-click</button> (mouse): Select multiple nodes individually.
3636
- <button class="kbc-button kbc-button-xs">Ctrl</button> + <button class="kbc-button kbc-button-xs">`</button> (Backtick key): Opens the terminal window for interactive console sessions or log viewing.
3737
- <button class="kbc-button kbc-button-xs">/</button> (Forward Slash): Search your environment for Kanvas elements matching your criteria.
38-
- <button class="kbc-button kbc-button-xs">`</button> (Backtick key): Close the Visualizer Terminal when it's open.
38+
- <button class="kbc-button kbc-button-xs">`</button> (Backtick key): Close the Operator Terminal when it's open.
3939

40-
These visualizer shortcuts are designed to streamline your interactions with the visualized data and provide you with the tools you need for efficient navigation and management.
40+
These operator shortcuts are designed to streamline your interactions with the visualized data and provide you with the tools you need for efficient navigation and management.
4141

4242
### Searching for Components
4343

content/en/kanvas/reference/releases/v0.7.121-7.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ prerelease: false
1212
- ci: add logical and for label kanvas @jerensl (#2990)
1313
- fix: labels and annotations not expanding by default @aabidsofi19 (#2988)
1414
- fix: double border stroke not legible in pamela @aabidsofi19 (#2987)
15-
- [Enhance] Mode Switcher: New Visualizer mode name and icon @leecalcote (#2986)
15+
- [Enhance] Mode Switcher: New Operator mode name and icon @leecalcote (#2986)
1616
- [Enhancement] Distinct arrowhead icon for annotation arrows @leecalcote (#2985)
1717
- fix border width value always zero in pamela @aabidsofi19 (#2984)
1818

content/en/kanvas/reference/troubleshooting.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -11,44 +11,44 @@ aliases:
1111

1212
Upon Meshery extension's first load, a GET request initializes the Kanvas plugin. Errors are classified into two types: plugin not found or built on a different version. Kanvas loads, and Designer is functional if no errors occur.
1313

14-
### Visualizer Mode
14+
### Operator Mode
1515

16-
GraphQL queries fetch header data and view data for the Visualizer canvas. Checks ensure data types and properties are correct, enabling canvas display. If no clusters are connected, a modal prompts the user to select one.
16+
GraphQL queries fetch header data and view data for the Operator canvas. Checks ensure data types and properties are correct, enabling canvas display. If no clusters are connected, a modal prompts the user to select one.
1717

1818
## Fault Scenarios Explained for Kanvas Extension
1919

2020
### 1. MISSING PLUGIN
2121

22-
- **MODE STATE:** Visualizer and Designer: Inactive, Not Interactable.
22+
- **MODE STATE:** Operator and Designer: Inactive, Not Interactable.
2323
- **CAUSED WHEN:** plugin.so is not in the desired folder.
2424
- **REMEDIATION:** Confirm plugin versions, run make dev or make prod on the local meshery-extension folder.
2525

2626
### 2. INCOMPATIBLE PLUGIN
2727

28-
- **MODE STATE:** Visualizer and Designer: Inactive, Not Interactable.
28+
- **MODE STATE:** Operator and Designer: Inactive, Not Interactable.
2929
- **CAUSED WHEN:** go.mod mismatches between meshery/meshery and layer5labs/meshery-extensions.
3030
- **REMEDIATION:** Ensure identical go.mod files and plugin version matching.
3131

3232
### 3. NO ACTIVE CLUSTER CONNECTIONS
3333

34-
- **MODE STATE:** Visualizer: Active, Not Interactable; Designer: Active, Interactable.
34+
- **MODE STATE:** Operator: Active, Not Interactable; Designer: Active, Interactable.
3535
- **CAUSED WHEN:** No active Kubernetes cluster connections.
3636
- **REMEDIATION:** Connect a Kubernetes cluster from settings.
3737

3838
### 4. MISSING MESHSYNC DATA / NATS NOT RUNNING
3939

40-
- **MODE STATE:** Visualizer: Active, Not Interactable; Designer: Active, Interactable.
40+
- **MODE STATE:** Operator: Active, Not Interactable; Designer: Active, Interactable.
4141
- **CAUSED WHEN:** Meshery Broker lacks an external IP address or networking issues.
4242
- **REMEDIATION:** Delete meshery-meshsync pod, use Docker Desktop/Kind/Minikube/external cloud provider.
4343

4444
### 5. CORRUPT DATABASE
4545

46-
- **MODE STATE:** Visualizer: Inactive, Not Interactable; Designer: Active, Interactable.
46+
- **MODE STATE:** Operator: Inactive, Not Interactable; Designer: Active, Interactable.
4747
- **CAUSED WHEN:** Unable to save/query database.
4848
- **REMEDIATION:** Use System Reset button or remove the config folder and rebuild Meshery.
4949

5050
### 6. INCOMPATIBLE MESHMAP AND MESHERY VERSION
5151

52-
- **MODE STATE:** Visualizer and Designer: Active, Interactable.
52+
- **MODE STATE:** Operator and Designer: Active, Interactable.
5353
- **CAUSED WHEN:** Meshery and Kanvas version mismatches.
5454
- **REMEDIATION:** Pull/build the latest Kanvas, update Mesheryctl and Meshery.

content/en/kanvas/tasks/designs/deploying-designs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ aliases:
1515

1616
3. This opens a modal that will take you through all the steps before the final deployment.
1717

18-
4. Click on **Open In Visualizer** to see the pre-filtered view of the deployed resources in the cluster
18+
4. Click on **Open In Operator** to see the pre-filtered view of the deployed resources in the cluster
1919

2020
5. Click **Finish**
2121

data/features.json

+9-9
Original file line numberDiff line numberDiff line change
@@ -666,7 +666,7 @@
666666
"Category": "Multiple Kubernetes Clusters",
667667
"Documented?": "",
668668
"Enterprise Comparison Tier": "x",
669-
"Feature": "Ongoing synchronization of Kubernetes configuration, workloads and service mesh changes across any number of Kubernetes clusters.",
669+
"Feature": "Management and ongoing synchronization of cloud native infrastructure across any number of Clouds and Kubernetes clusters.",
670670
"Free Comparison Tier": "",
671671
"Function": "Multiple Kubernetes Clusters",
672672
"Pricing page?": "X",
@@ -798,10 +798,10 @@
798798
}
799799
},
800800
{
801-
"documentation": "https://docs.layer5.io/kanvas/visualizer/visualizer-views/",
801+
"documentation": "https://docs.layer5.io/kanvas/operator/operator-views/",
802802
"entire_row": {
803803
"Category": "Operator",
804-
"Documented?": "https://docs.layer5.io/kanvas/visualizer/visualizer-views/",
804+
"Documented?": "https://docs.layer5.io/kanvas/operator/operator-views/",
805805
"Enterprise Comparison Tier": "x",
806806
"Feature": "See all views withing a workspace",
807807
"Free Comparison Tier": "",
@@ -813,10 +813,10 @@
813813
}
814814
},
815815
{
816-
"documentation": "https://docs.layer5.io/kanvas/visualizer/visualizer-views/#4-delete-a-view",
816+
"documentation": "https://docs.layer5.io/kanvas/operator/operator-views/#4-delete-a-view",
817817
"entire_row": {
818818
"Category": "Operator",
819-
"Documented?": "https://docs.layer5.io/kanvas/visualizer/visualizer-views/#4-delete-a-view",
819+
"Documented?": "https://docs.layer5.io/kanvas/operator/operator-views/#4-delete-a-view",
820820
"Enterprise Comparison Tier": "x",
821821
"Feature": "Dissolve environment and all connection memberships. Leave associated resources intact.",
822822
"Free Comparison Tier": "",
@@ -828,10 +828,10 @@
828828
}
829829
},
830830
{
831-
"documentation": "https://docs.layer5.io/kanvas/visualizer/visualizer-views/#5-export-a-view",
831+
"documentation": "https://docs.layer5.io/kanvas/operator/operator-views/#5-export-a-view",
832832
"entire_row": {
833833
"Category": "Operator",
834-
"Documented?": "https://docs.layer5.io/kanvas/visualizer/visualizer-views/#5-export-a-view",
834+
"Documented?": "https://docs.layer5.io/kanvas/operator/operator-views/#5-export-a-view",
835835
"Enterprise Comparison Tier": "x",
836836
"Feature": "Export views to JSON format",
837837
"Free Comparison Tier": "",
@@ -843,10 +843,10 @@
843843
}
844844
},
845845
{
846-
"documentation": "https://docs.layer5.io/kanvas/visualizer/visualizer-views/#3-share-a-view",
846+
"documentation": "https://docs.layer5.io/kanvas/operator/operator-views/#3-share-a-view",
847847
"entire_row": {
848848
"Category": "Operator",
849-
"Documented?": "https://docs.layer5.io/kanvas/visualizer/visualizer-views/#3-share-a-view",
849+
"Documented?": "https://docs.layer5.io/kanvas/operator/operator-views/#3-share-a-view",
850850
"Enterprise Comparison Tier": "x",
851851
"Feature": "Share Views",
852852
"Free Comparison Tier": "",

0 commit comments

Comments
 (0)