Merge branch 'master' into aboobakersiddiqr63/docs-manualcont-changes

meshery · Nov 22, 2023 · bfb8611 · bfb8611
2 parents 979747d + d052915
commit bfb8611
Show file tree

Hide file tree

Showing 235 changed files with 7,618 additions and 2,673 deletions.
diff --git a/docs/_data/discuss/meshery.json b/docs/_data/discuss/meshery.json
diff --git a/docs/_data/discuss/mesheryctl.json b/docs/_data/discuss/mesheryctl.json
diff --git a/docs/_data/toc.yml b/docs/_data/toc.yml
@@ -52,10 +52,14 @@
   links:
     - title: Community
       url: project/community
+    - title: Releases
+      url: project/releases
+    - title: Vulnerabilities
+      url: project/security-vulnerabilities
     - title: Contributing ↆ
       url: project/contributing
       children:
-        - title: Build & Release (CI)
+        - title: "Build & Release (CI)"
           url: project/contributing/build-and-release
           grandchildren:
           - title: "- End-to-End Testing"
@@ -80,11 +84,6 @@
           url: project/contributing/contributing-ui
         - title: Docker Extension
           url: project/contributing/contributing-docker-extension
-
-    - title: Releases
-      url: project/releases
-    - title: Vulnerabilities
-      url: project/security-vulnerabilities
 - title: 🧠 Concepts
   url: concepts
   links:
@@ -126,19 +125,6 @@
             url: concepts/credentials
         - title: "Workspaces"
           url: concepts/workspaces
-- title: ⚙️ Tasks (all)
-  url: tasks
-  links:
-    - title: Application Management
-      url: tasks/application-management
-    - title: Filter Management
-      url: tasks/filter-management
-    - title: Lifecycle Management
-      url: tasks/lifecycle-management
-    - title: Pattern Management
-      url: tasks/pattern-management
-    - title: Performance Management
-      url: tasks/performance-management
 #    - title: Meshery and SMI Management
 #      url: tasks/service-mesh-interface  
 # - title: 📑 Features
@@ -187,6 +173,10 @@
       # url: guides/smi-conformance
     - title: Configuring Kubernetes Infrastructure
       url: guides/configuration-management
+    - title: Creating a Meshery Design
+      url: guides/creating-a-meshery-design
+    - title: Managing Events with Notification Center
+      url: guides/events-management
     - title: Integrating Prometheus and Grafana
       url: guides/meshery-metrics
     - title: Importing Applications
@@ -195,10 +185,6 @@
       url: guides/pipelining-service-mesh-specifications
     - title: Performance Management with Meshery
       url: guides/performance-management
-    - title: Troubleshooting Guide
-      url: guides/troubleshooting
-    - title: Upgrading Meshery
-      url: guides/upgrade
     - title: Using mesheryctl ↆ
       url: guides/mesheryctl
       children:
@@ -214,6 +200,23 @@
           url: guides/mesheryctl/running-system-checks-using-mesheryctl
     - title: Using Multiple Meshery Adapters
       url: guides/multiple-adapters
+    - title: Troubleshooting Guide
+      url: guides/troubleshooting
+    - title: Upgrading Meshery
+      url: guides/upgrade
+- title: ⚙️ Tasks (all)
+  url: tasks
+  links:
+    - title: Infrastructure Management
+      url: tasks/infrastructure-management
+    - title: Filter Management
+      url: tasks/filter-management
+    - title: Lifecycle Management
+      url: tasks/lifecycle-management
+    - title: Pattern Management
+      url: tasks/pattern-management
+    - title: Performance Management
+      url: tasks/performance-management
 - title: 🛠 Extensibility
   url: extensibility
   links:

diff --git a/docs/_includes/sidebar.html b/docs/_includes/sidebar.html
@@ -74,7 +74,7 @@
                         href="{{grandchildUrl}}"
                         >{{ grandchild.title }}</a
                       >
-                    </li>
+                      </li>
                       {% endfor %}
                   </ul>
                   {% endif %} 

diff --git a/docs/_releases/v0.6.179.md b/docs/_releases/v0.6.179.md
@@ -0,0 +1,35 @@
+---
+layout: release
+date: 2023-11-20
+tag: v0.6.179
+---
+
+## What's New
+## 🔤 General
+- [Server] update status at the end of the final state @MUzairS15 (#9402)
+- [Server] Handle events emitted by `Execute funcs` properly. @MUzairS15 (#9397)
+- Add New shapes (Polygons) @aabidsofi19 (#9374)
+
+## 🖥 Meshery UI
+
+- Enhance Dashboard @theBeginner86 (#9352)
+- fix ui bug in dark mode of modal @vaibhavpnimkar (#9389)
+- Registryui @ptdatta (#9370)
+- [Connections] Connection State Management @MUzairS15 (#9383)
+
+## 🧰 Maintenance
+
+- Bump golang.org/x/oauth2 from 0.12.0 to 0.14.0 @dependabot (#9341)
+
+## 📖 Documentation
+
+- [Docs] Managing infrastructure with Meshery. @MUzairS15 (#9391)
+
+## 🔒 Security
+
+- Filter "order by" parameter to fix sql inject vuln @phant0ms (#9372)
+
+## 👨🏽‍💻 Contributors
+
+Thank you to our contributors for making this release possible:
+@MUzairS15, @Yashsharma1911, @aabidsofi19, @dependabot, @leecalcote, @phant0ms, @ptdatta, @theBeginner86 and @vaibhavpnimkar
diff --git a/docs/_releases/v0.6.180.md b/docs/_releases/v0.6.180.md
@@ -0,0 +1,23 @@
+---
+layout: release
+date: 2023-11-21
+tag: v0.6.180
+---
+
+## What's New
+## 🔤 General
+- [Connection] Add connection & credential definitions for `Meshery` model. @MUzairS15 (#9409)
+- [Server] Perform transitions in a separate routine @MUzairS15 (#9407)
+
+## ⌨️ Meshery CLI
+
+- [chore] Run `gofmt`. @MUzairS15 (#9408)
+
+## 🖥 Meshery UI
+
+- [chore] rm comments @theBeginner86 (#9404)
+
+## 👨🏽‍💻 Contributors
+
+Thank you to our contributors for making this release possible:
+@MUzairS15, @leecalcote and @theBeginner86
diff --git a/docs/_sass/sidebar.scss b/docs/_sass/sidebar.scss
@@ -174,24 +174,39 @@
         }
 
         & > ul {
-          padding-inline-start: 2rem;
+          padding-inline-start: .3rem;
           list-style: none;
           margin-bottom: 0;
 
+          & > ul {
+            padding-inline-start: .3rem;
+            list-style: none;
+            margin-bottom: 0;
+
+            & > li  {
+              list-style: none;
+              display: flex;
+              flex-direction: column;
+              gap: 0.5rem;
+              padding-inline-start: .3rem;
+              margin-bottom: 0;
+            }
+          }
+
           & > li ul {
             list-style: none;
             display: flex;
             flex-direction: column;
             gap: 0.5rem;
-            padding-inline-start: 1rem;
+            padding-inline-start: .3rem;
             margin-bottom: 0;
 
             & > li ul {
               display: flex;  
-              list-style: disc;
+              list-style: none !important;
               flex-direction: column;
               gap: .25rem;
-              // padding-inline-start: 1rem;
+              padding-inline-start: .3rem;
             }
             // & ul > li {
             //   & ::before {

diff --git a/docs/pages/concepts/architectural/architecture.md b/docs/pages/concepts/architectural/architecture.md
@@ -34,61 +34,90 @@ Meshery deploys as a set of containers. Meshery's containers can be deployed to
 
 In Meshery v0.6.0, Adapters will register with Meshery Server over HTTP POST. If Meshery Server is not available, Meshery Adapters will backoff and retry to connect to Meshery Server perpetually.
 
-[![Meshery architecture]({{ site.baseurl }}/assets/img/architecture/meshery-architecture.svg)]({{ site.baseurl }}/assets/img/architecture/meshery-architecture.svg)
+<a href="{{ site.baseurl }}/assets/img/architecture/meshery-architecture.svg">
+<img src="{{ site.baseurl }}/assets/img/architecture/meshery-architecture.svg" width="50%" /></a>
+<figure>
+  <figcaption>Figure: Meshery architecture</figcaption>
+</figure>
 
 _Figure: Meshery deploys inside or outside of a Kubernetes cluster_
 
 #### Adapters and Capabilities Registry
 
 Each Meshery Adapter delivers its own unique specific functionality. As such, at time of deployment, the Meshery Adapter will register its cloud native infrastructure-specific capabilities (its operations) with Meshery Server's capability registry.
-
-[![Meshery Adapter Operation Registration]({{ site.baseurl }}/assets/img/adapters/meshery-adapter-operation-registration.svg
-)]({{ site.baseurl }}/assets/img/adapters/meshery-adapter-operation-registration.svg)
+<a href="{{ site.baseurl }}/assets/img/adapters/meshery-adapter-operation-registration.svg">
+<img src="{{ site.baseurl }}/assets/img/adapters/meshery-adapter-operation-registration.svg" width="50%" /></a>
+<figure>
+  <figcaption>Figure: Meshery Adapter Operation Registratio</figcaption>
+</figure>
 
 _Figure: Meshery Adapter Operation Registration_
 
 ### Clients
 
 Meshery's REST API may be consumed by any number of clients. Clients need to present valid JWT token.
 
-[![Client architecture]({{ site.baseurl }}/assets/img/architecture/Meshery-client-architecture.svg)]({{ site.baseurl }}/assets/img/architecture/Meshery-client-architecture.svg)
+<a href="{{ site.baseurl }}/assets/img/architecture/Meshery-client-architecture.svg">
+<img src="{{ site.baseurl }}/assets/img/architecture/Meshery-client-architecture.svg" width="50%" /></a>
+<figure>
+  <figcaption>Figure: Meshery Client architecture</figcaption>
+</figure>
 
 _Figure: Clients use Meshery's [REST API](extensibility/api#rest), [GraphQL API](extensibility/api#graphql), or a combination of both._
 
 ### Providers
 
 As a point of extension, Meshery supports two types of providers: _Local_ and _Remote_.
 
-[![Provider architecture]({{ site.baseurl }}/assets/img/architecture/Meshery-provider-architecture.svg)]({{ site.baseurl }}/assets/img/architecture/Meshery-provider-architecture.svg)
+<a href="{{ site.baseurl }}/assets/img/architecture/Meshery-provider-architecture.svg">
+<img src="{{ site.baseurl }}/assets/img/architecture/Meshery-provider-architecture.svg" width="50%" /></a>
+<figure>
+  <figcaption>Figure: Meshery Provider architecture</figcaption>
+</figure>
 
 ## Object Model
 
 This diagram outlines logical constructs within Meshery and their relationships.
 
-[![Object Model]({{ site.baseurl }}/assets/img/architecture/meshery_logical_object_model.svg)]({{ site.baseurl }}/assets/img/architecture/meshery_logical_object_model.svg)
+<a href="{{ site.baseurl }}/assets/img/architecture/meshery_logical_object_model.svg">
+<img src="{{ site.baseurl }}/assets/img/architecture/meshery_logical_object_model.svg" width="50%" /></a>
+<figure>
+  <figcaption>Figure: Meshery Object Model</figcaption>
+</figure>
 
 ## Meshery Operator and MeshSync
 
 Meshery Operator is the multi-cluster Kubernetes operator that manages MeshSync and Meshery Broker.
 
-[![Meshery Operator and MeshSync]({{ site.baseurl }}/assets/img/architecture/meshery-operator-and-meshsync.svg
-)]({{ site.baseurl }}/assets/img/architecture/meshery-operator-and-meshsync.svg)
+<a href="{{ site.baseurl }}/assets/img/architecture/meshery-operator-and-meshsync.svg">
+<img src="{{ site.baseurl }}/assets/img/architecture/meshery-operator-and-meshsync.svg" width="50%" /></a>
+<figure>
+  <figcaption>Figure: Meshery Operator and MeshSync</figcaption>
+</figure>
 
 See the [**Operator**]({{ site.baseurl }}/concepts/architecture/operator) section for more information on the function of an operator and [**MeshSync**]({{ site.baseurl }}/concepts/architecture/meshsync) section for more information on the function of meshsync.
 
 ## Database
 
 Meshery Server's database is responsible for collecting and centralizing the state of all elements under management, including infrastructure, application, and Meshery's own components. Meshery's database, while persisted to file, is treated as a cache.
 
-[![Meshery Database]({{ site.baseurl }}/assets/img/architecture/meshery-database.svg)]({{ site.baseurl }}/concepts/architecture/database)
+<a href="{{ site.baseurl }}/assets/img/architecture/meshery-database.svg">
+<img src="{{ site.baseurl }}/assets/img/architecture/meshery-database.svg" width="50%" /></a>
+<figure>
+  <figcaption>Figure: Meshery Docker Extension</figcaption>
+</figure>
 
 _See the [**Database**]({{ site.baseurl }}/concepts/architecture/database) section for more information on the function of the database._
 
 ## Meshery Docker Extension 
 
 Meshery's Docker extension provides a simple and flexible way to design and operate cloud native infrastructure on top of Kubernetes using Docker containers. The architecture of this extension is designed to be modular and extensible, with each component serving a specific purpose within the overall deployment process.
 
-[![Meshery Database]({{ site.baseurl }}/assets/img/architecture/meshery-docker-extension.svg)]({{ site.baseurl }}/assets/img/architecture/meshery-docker-extension.svg)
+<a href="{{ site.baseurl }}/assets/img/architecture/meshery-docker-extension.svg">
+<img src="{{ site.baseurl }}/assets/img/architecture/meshery-docker-extension.svg" width="50%" /></a>
+<figure>
+  <figcaption>Figure: Meshery Docker Extension</figcaption>
+</figure>
 
 
 ### **Statefulness in Meshery components**

diff --git a/docs/pages/concepts/architectural/meshsync.md b/docs/pages/concepts/architectural/meshsync.md
@@ -29,6 +29,7 @@ list: include
 - **Scalable and Performant**: Meshery's event-driven approach ensures speed and scalability. You have control over the depth of object discovery to manage large clusters efficiently. MeshSync's working snapshot of the state of each cluster under management is stored in the Server's local database and continuously refreshed.
 
 ## Discovery
+
 MeshSync supports both greenfield and brownfield discovery of infrastructure. Greenfield discovery manages infrastructure created and managed entirely by Meshery, while brownfield discovery identifies separately created infrastructure.
 
 ### Brownfield: Discovering existing resources

diff --git a/docs/pages/concepts/logical/components.md b/docs/pages/concepts/logical/components.md
@@ -12,3 +12,11 @@ list: include
 
 [![Meshery Components]({{ site.baseurl }}/assets/img/architecture/meshery-components.svg
 )]({{ site.baseurl }}/assets/img/architecture/meshery-components.svg)
+
+## Component Status
+
+Components have a status that is represented as a `Connection` object. Both the administrative and real-time status of a component is a normalized representation of the connection's state. The status is represented as a `Connection` object because the status of a component is a *connection* to the component. For example, the status of a Kubernetes cluster is a direct reflection of a Meshery Server's connection to the cluster.
+
+Normalizing and extracting the status of a component as a direct property of the component and putting it into a connection allows multiple systems to share the same component with different states. For example, different Meshery Servers can access the same Kubernetes cluster, but each Meshery Server has its own connection to the cluster with its own status.
+
+Learn more about [Connections](/concepts/connections).