Skip to content
This repository has been archived by the owner on Mar 3, 2022. It is now read-only.

Commit

Permalink
updating user guide structure
Browse files Browse the repository at this point in the history
Signed-off-by: Umasankar Mukkara <umasankar.mukkara@openebs.io>
  • Loading branch information
umamukkara committed Jun 7, 2019
1 parent b51436c commit fba8cfa
Show file tree
Hide file tree
Showing 8 changed files with 286 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/casengines.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: casengines
title: OpenEBS Storage Engines - cStor and Jiva
sidebar_label: CAS Engines (cStor & Jiva)
title: OpenEBS Storage Engines - cStor, Jiva and LocalPV
sidebar_label: CAS Engines
---

------
Expand Down
2 changes: 0 additions & 2 deletions docs/configuresc.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---


id: configuresc
title: Configuring Storage Classes
sidebar_label: Configuring StorageClasses
Expand Down
55 changes: 55 additions & 0 deletions docs/localpv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
id: localpv
title: OpenEBS LocalPV
sidebar_label: Local PV
---
------



## Slack

The OpenEBS team hangs out on Slack in the #openebs-users channel. To participate in discussions with the OpenEBS team go to <a href="https://openebs.io/join-our-community" target="_blank">Slack OpenEBS Community</a>

Slack requires registration, but the OpenEBS team welcomes anyone to register at <a href="https://openebs.io/join-our-community" target="_blank">Slack OpenEBS Community</a>

## MayaOnline

All community users by default are subscribed to a free plan on <a href="https://mayaonline.io/" target="_blank">MayaOnline</a>. Enterprise support comes with various support subscription plans.



## Blogs

Community blogs are available at [https://blog.openebs.io](https://blog.openebs.io).



<br>

<hr>

<br>

<!-- Hotjar Tracking Code for https://docs.openebs.io -->
<script>
(function(h,o,t,j,a,r){
h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
h._hjSettings={hjid:785693,hjsv:6};
a=o.getElementsByTagName('head')[0];
r=o.createElement('script');r.async=1;
r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
a.appendChild(r);
})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
</script>


<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-92076314-12"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'UA-92076314-12');
</script>
34 changes: 34 additions & 0 deletions docs/ndm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
id: ndm
title: Node Device Manager
sidebar_label: NDM
---
------






<!-- Hotjar Tracking Code for https://docs.openebs.io -->
<script>
(function(h,o,t,j,a,r){
h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
h._hjSettings={hjid:785693,hjsv:6};
a=o.getElementsByTagName('head')[0];
r=o.createElement('script');r.async=1;
r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
a.appendChild(r);
})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
</script>


<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-92076314-12"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'UA-92076314-12');
</script>
81 changes: 81 additions & 0 deletions docs/ugcstor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
id: ugcstor
title: cStor User Guide
sidebar_label: cStor
---
------



<font size="5">User operations</font>

Provisioning a cStor volume

Resizing a volume

Backup and restore

Upgrading the cStor version of a volume





<font size="5">Admin operations</font>

Creating cStor storage pools

Creating cStor storage classes

Upgrade software version of a cStor pool

Expanding cStor pool to a new node

Expanding size of a cStor pool instance on a node (add physical/virtual disks to a pool instance)

Expanding size of a cStor pool instance on a node (expanding the size of cloud disks)

Deleting a pool instance







<br>

<hr>

<br>



<br>

<hr>

<br>

<!-- Hotjar Tracking Code for https://docs.openebs.io -->
<script>
(function(h,o,t,j,a,r){
h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
h._hjSettings={hjid:785693,hjsv:6};
a=o.getElementsByTagName('head')[0];
r=o.createElement('script');r.async=1;
r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
a.appendChild(r);
})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
</script>


<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-92076314-12"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'UA-92076314-12');
</script>
47 changes: 47 additions & 0 deletions docs/uglocalpv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
id: uglocalpv
title: OpenEBS Local PV User Guide
sidebar_label: Local PV
---
------



<font size="5">User operations</font>

None

<font size="5">Admin operations</font>





<br>

<hr>

<br>

<!-- Hotjar Tracking Code for https://docs.openebs.io -->
<script>
(function(h,o,t,j,a,r){
h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
h._hjSettings={hjid:785693,hjsv:6};
a=o.getElementsByTagName('head')[0];
r=o.createElement('script');r.async=1;
r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
a.appendChild(r);
})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
</script>


<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-92076314-12"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'UA-92076314-12');
</script>
65 changes: 65 additions & 0 deletions docs/ugndm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
id: ugndm
title: Node Device Manager User Guide
sidebar_label: NDM
---
------



<font size="5">User operations</font>

None

<font size="5">Admin operations</font>

Include filters

Exclude filters

Partitioning disks



<br>

<hr>

<br>



## User Operations



## Admin Operations

<br>

<hr>

<br>

<!-- Hotjar Tracking Code for https://docs.openebs.io -->
<script>
(function(h,o,t,j,a,r){
h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
h._hjSettings={hjid:785693,hjsv:6};
a=o.getElementsByTagName('head')[0];
r=o.createElement('script');r.async=1;
r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
a.appendChild(r);
})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
</script>


<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-92076314-12"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'UA-92076314-12');
</script>
3 changes: 2 additions & 1 deletion website/sidebars.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
{
"docs": {
"Introduction": ["overview","features", "usecases", "releases", "support", "mayaonline"],
"Concepts": ["cas", "architecture", "casengines","cstor","jiva", "localpv", "ndm"],
"User Guides": ["quickstart", "prerequisites", "installation", "ugndm", "ugcstor", "jivaguide", "uglocalpv", "operations", "mayactl","backup", "upgrade", "uninstall" ],
"Concepts": ["cas", "architecture", "casengines","cstor","jiva"],
"User Guides": ["quickstart", "prerequisites", "installation", "configurepools", "configuresc", "provisionvols", "operations", "openebslocalpv", "jivaguide", "mayactl","backup", "upgrade", "uninstall" ],
"Stateful Applications": ["mysql", "prometheus", "minio", "gitlab", "percona", "elasticsearch", "cassandra","nuodb", "postgres", "redis", "mongo", "jira", "rwm"],
"Advanced Topics": ["performance", "faq", "k8supgrades", "troubleshooting", "kb", "tasks"]
}
Expand Down

0 comments on commit fba8cfa

Please sign in to comment.