Skip to content

Commit

Permalink
docs: remove /k8s directory
Browse files Browse the repository at this point in the history
Signed-off-by: Niladri Halder <niladri.halder26@gmail.com>
  • Loading branch information
niladrih committed Apr 19, 2024
1 parent 0ed93f1 commit 80e7737
Show file tree
Hide file tree
Showing 444 changed files with 113 additions and 46,794 deletions.
9 changes: 0 additions & 9 deletions .gitignore
Expand Up @@ -11,15 +11,6 @@
# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Kubernetes demo
k8s/demo/.vagrant/
k8s/demo/*.log
k8s/demo/*test*

# Kubernetes lib
k8s/lib/vagrant/*.box
k8s/lib/vagrant/*.log

# Local build for docs
documentation/build/

Expand Down
14 changes: 9 additions & 5 deletions CONTRIBUTING.md
Expand Up @@ -8,10 +8,14 @@ However, for those individuals who want a bit more guidance on the best way to c

That said, OpenEBS is an innovation in Open Source. You are welcome to contribute in any way you can and all the help provided is very much appreciated.

- [Raise issues to request new functionality, fix documentation or for reporting bugs.](#raising-issues)
- [Submit changes to improve documentation.](#submit-change-to-improve-documentation)
- [Submit proposals for new features/enhancements.](#submit-proposals-for-new-features)
- [Solve existing issues related to documentation or code.](#contributing-to-source-code-and-bug-fixes)
- [Contributing to OpenEBS](#contributing-to-openebs)
- [Raising Issues](#raising-issues)
- [Submit Change to Improve Documentation](#submit-change-to-improve-documentation)
- [Submit Proposals for New Features](#submit-proposals-for-new-features)
- [Contributing to Source Code and Bug Fixes](#contributing-to-source-code-and-bug-fixes)
- [Solve Existing Issues](#solve-existing-issues)
- [Sign your work](#sign-your-work)
- [Join our community](#join-our-community)

There are a few simple guidelines that you need to follow before providing your hacks.

Expand Down Expand Up @@ -39,7 +43,7 @@ There is always something more that is required, to make it easier to suit your
Provide PRs with appropriate tags for bug fixes or enhancements to the source code. For a list of tags that could be used, see [this](./contribute/labels-of-issues.md).

- For contributing to K8s demo, please refer to this [document](./contribute/CONTRIBUTING-TO-K8S-DEMO.md).
- For checking out how OpenEBS works with K8s, refer to this [document](./k8s/README.md)
- For checking out how OpenEBS works with K8s, refer to our [documentation](https://openebs.io/docs)

* For contributing to Kubernetes OpenEBS Provisioner, please refer to this [document](./contribute/CONTRIBUTING-TO-KUBERNETES-OPENEBS-PROVISIONER.md).

Expand Down
4 changes: 1 addition & 3 deletions contribute/CONTRIBUTING-TO-K8S-DEMO.md
Expand Up @@ -2,11 +2,9 @@

This document describes the process for adding or improving the existing examples of applications using OpenEBS Volumes.

Kubernetes YAML files for running application using OpenEBS Volumes are located under the folder [openebs/k8s/demo](https://github.com/openebs/openebs/tree/master/k8s/demo)

Each application example should comprise of the following:

- K8s YAML file(s) for starting the application and its associated components. The volumes should point to the OpenEBS Storage Class. If the existing storage-classes does not suit the need, create a new storage class at [openebs-storageclasses.yaml](../k8s/openebs-storageclasses.yaml).
- K8s YAML file(s) for starting the application and its associated components. The volumes should point to the OpenEBS Storage Class. If the existing storage-classes do not suit the need, you may create a new storage class. Refer to our [documentation](https://openebs.io/docs) for examples.
- K8s YAML file(s) for starting a client that accesses the application. This is optional, in case the application itself provides a mechanism like in Jupyter, Wordpress, etc.

When demonstrating a database-like application like Apache Cassandra, Redis, and so on, it is recommended to have such a mechanism to test that the application has been launched.
Expand Down
20 changes: 9 additions & 11 deletions contribute/design/1.x/jiva/2019152019-jiva-autosnap-deletion.md
Expand Up @@ -24,14 +24,15 @@ superseded-by:

## Table of Contents

* [Table of Contents](#table-of-contents)
* [Summary](#summary)
* [Motivation](#motivation)
* [Goals](#goals)
* [Proposal](#proposal)
* [Implementation Details](#implementation-details)
* [Performance impact](#performance-impact)
* [Alternatives](#alternatives)
- [Jiva automatic snapshot deletion](#jiva-automatic-snapshot-deletion)
- [Table of Contents](#table-of-contents)
- [Summary](#summary)
- [Motivation](#motivation)
- [Goals](#goals)
- [Proposal](#proposal)
- [Implementation Details](#implementation-details)
- [Performance impact](#performance-impact)
- [Alternatives](#alternatives)

## Summary

Expand Down Expand Up @@ -98,9 +99,6 @@ superseded-by:
snapshot deletion is in progress by validating the chain and restart is
required to rebuild the replica to be on the safer side.

NOTE: A script is written to delete the given no of snapshots automatically. You
can find the script [here](https://github.com/openebs/openebs/blob/master/k8s/jiva/snapshot-cleanup.sh)

b) **Cleanup in background by picking the snapshots with smallest size**:

- Run a goroutine which will pick up snapshots based on its size and start
Expand Down
42 changes: 22 additions & 20 deletions contribute/design/1.x/upgrade/volume-pools-upgrade.md
Expand Up @@ -22,22 +22,27 @@ superseded-by:

## Table of Contents

* [Table of Contents](#table-of-contents)
* [Summary](#summary)
* [Motivation](#motivation)
* [Goals](#goals)
* [Non-Goals](#non-goals)
* [Proposal](#proposal)
* [User Stories](#user-stories)
* [Design Constraints](#design-constraints)
* [Proposed Implementation](#proposed-implementation)
* [High Level Design](#high-level-design)
* [Risks and Mitigations](#risks-and-mitigations)
* [Graduation Criteria](#graduation-criteria)
* [Implementation History](#implementation-history)
* [Drawbacks](#drawbacks)
* [Alternatives](#alternatives)
* [Infrastructure Needed](#infrastructure-needed)
- [Upgrade via Kubernetes Job](#upgrade-via-kubernetes-job)
- [Table of Contents](#table-of-contents)
- [Summary](#summary)
- [Motivation](#motivation)
- [Goals](#goals)
- [Non-Goals](#non-goals)
- [Proposal](#proposal)
- [User Stories](#user-stories)
- [Design Constraints](#design-constraints)
- [Proposed Implementation](#proposed-implementation)
- [Backward Compatibility](#backward-compatibility)
- [Design Choices/Decisions](#design-choicesdecisions)
- [High Level Design](#high-level-design)
- [Upgrade Job Example](#upgrade-job-example)
- [UpgradeTask CR Example](#upgradetask-cr-example)
- [Risks and Mitigations](#risks-and-mitigations)
- [Graduation Criteria](#graduation-criteria)
- [Implementation History](#implementation-history)
- [Drawbacks](#drawbacks)
- [Alternatives](#alternatives)
- [Infrastructure Needed](#infrastructure-needed)

## Summary

Expand Down Expand Up @@ -208,9 +213,7 @@ This design proposes the following key changes:
UpgradeJob is executed on an already upgraded resource, it will
return success.

Note: This replaces the script based upgrades from OpenEBS 1.0.
Sample Kubernetes YAMLs for upgrading various resources can be
found [here](../../../../k8s/upgrades/1.0.0-1.1.0/).
Note: This replaces the script based upgrades from OpenEBS 1.0.

Status: Available in 1.1 and supports upgrading of Jiva Volumes,
cStor Volumes and cStor pools from 1.0 to 1.1
Expand Down Expand Up @@ -353,7 +356,6 @@ and the reasoning behind selecting a certain approach.


- How does this design compared to the `kubectl` based upgrade
introduced for upgrading from [0.8.2 to 0.9](https://github.com/openebs/openebs/tree/master/k8s/upgrades/0.8.2-0.9.0).

The current design proposed in this document builds on top of the
0.8.2 to 0.9 design, by improving on usability and agility of the
Expand Down
90 changes: 0 additions & 90 deletions k8s/README.md

This file was deleted.

19 changes: 0 additions & 19 deletions k8s/charts/openebs/Chart.yaml

This file was deleted.

0 comments on commit 80e7737

Please sign in to comment.