Skip to content

Commit

Permalink
concepts
Browse files Browse the repository at this point in the history
Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
  • Loading branch information
leecalcote committed Oct 19, 2023
1 parent 02ac40a commit 6526e4e
Show file tree
Hide file tree
Showing 8 changed files with 77 additions and 8 deletions.
12 changes: 11 additions & 1 deletion docs/_data/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,18 +93,28 @@
url: concepts/architecture/broker
- title: "- Meshsync"
url: concepts/architecture/meshsync
- title: Conceptual
- title: Logical
url: concepts/logical
children:
- title: "Designs"
url: concepts/designs
- title: "Environments"
url: concepts/environments
- title: "Filters"
url: concepts/filters
- title: "Models"
url: concepts/models
grandchildren:
- title: "- Components"
url: concepts/components
- title: "- Relationships"
url: concepts/relationships
- title: "- Policies"
url: concepts/policies
- title: "- Connections"
url: concepts/connections
- title: "- Credentials"
url: concepts/credentials
- title: "Workspaces"
url: concepts/workspaces
- title: ⚙️ Tasks (all)
Expand Down
11 changes: 11 additions & 0 deletions docs/pages/concepts/logical/components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
layout: default
title: Components
permalink: concepts/components
type: concepts
abstract: "Meshery Components identify and characterize infrastructure under management."
language: en
list: include
---

[Components](https://github.com/meshery/meshery/tree/master/server/meshmodel/components) represent entities in the Meshery ecosystem, exposing capabilities of the underlying platform. They can be registered, created, and used by users and operators. Components have definitions, instances, and associated metadata. Components having the same `kind`, `apiVersion` and `model.name` attributes are considered duplicates.
10 changes: 10 additions & 0 deletions docs/pages/concepts/logical/credentials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
layout: default
title: Credentials
permalink: concepts/credentials
type: concepts
abstract: Meshery uses one or more Credentials when authenticating to a managed or unmanaged Connection.
language: en
list: include
---
Meshery uses one or more Credentials when authenticating to a managed or unmanaged Connection.
11 changes: 11 additions & 0 deletions docs/pages/concepts/logical/relationships.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
layout: default
title: Relationships
permalink: concepts/relationshps
type: concepts
abstract: "Meshery Relationships identify and facilitate genealogy between Components."
language: en
list: include
---

[Relationships](https://github.com/meshery/meshery/tree/master/server/meshmodel/relationships) define the nature of interaction between interconnected components in MeshModel. They represent various types of connections and dependencies between components, such as hierarchical, network, or default relationships. Relationships have selectors, metadata, and optional parameters.
4 changes: 2 additions & 2 deletions docs/pages/concepts/logical/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ language: en
list: include
---

## Workspaces

Workspaces act as central collaboration points for teams and their project work. Often, users create a Workspace for each project or for each team as a way of organizing domains of project work to facilitate collaboration and provide access control over resources with a project. Workspaces are sometimes likened to the concept of a project - a collection of individuals responsible for the development and operation of an application or service.

### Using Workspaces
## Using Workspaces

After creating a Workspace, of your next steps is to resource that Workspace. Like a shared drive (or or shared collection of files). Workspaces are your Google Drive, while Meshery Designs are your Google Docs.


Expand Down
10 changes: 10 additions & 0 deletions docs/pages/concepts/policies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
layout: default
title: Policies
permalink: concepts/policies
type: concepts
abstract: "Meshery Policies enable you with a broad set of controls and governance of the behavior of systems under Meshery's management."
language: en
list: include
---
Policies offer an evaluation algorithm to ensure desired behavior enforcement. [Policies](https://github.com/meshery/meshery/tree/master/server/meshmodel/policies) can be applied to components and relationships, defining rules and actions based on predefined conditions.
23 changes: 20 additions & 3 deletions docs/pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,28 @@ language: en
</a>
<!-- <h6>Getting Started</h6> -->
<ul>
<li><a href="{{ site.baseurl }}/project">Project Overview</a></li>
<!-- <li><a href="{{ site.baseurl }}/project">Project Overview</a></li> -->
<li><a href="{{ site.baseurl }}/installation/quick-start">Quick Start</a></li>
<!-- <li><a href="{{ site.baseurl }}/project">Essential Features</a></li> -->
</ul>
<details>
<summary>
<h6 style="display:inline">
<a href="{{ site.baseurl }}/installation/" class="text-black">Supported Platforms</a>
</h6>
</summary>
<ul class="section-title">
{% for item in sorted_pages %}
{% if item.type=="installation" and item.list=="include" and item.language == "en" -%}
<li><a href="{{ site.baseurl }}{{ item.url }}">{{ item.title }}</a>
{% if item.abstract %}
- {{ item.abstract }}
{% endif %}
</li>
{% endif %}
{% endfor %}
</ul>
</details>
</div>

<!-- CONCEPTS -->
Expand Down Expand Up @@ -216,5 +234,4 @@ language: en
<!-- <div style="text-align:center;padding:0;margin:0;">
<img src="https://layer5.io/assets/images/meshery/meshery-logo-shadow-light-white-text-side.svg" width="60%" />
<h1>Documentation</h1>
</div> -->

</div> -->
4 changes: 2 additions & 2 deletions docs/pages/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
layout: default
title: Installation
type: installation
abstract: Installation procedures for deploying Meshery.
abstract: Installation procedures for deploying Meshery with mesheryctl.
permalink: installation
redirect_from:
- installation/
- installation
language: en
list: exclude
list: include
---

## Supported Platforms
Expand Down

0 comments on commit 6526e4e

Please sign in to comment.