Skip to content

Commit bc45486

Browse files
committed
fix license, add how to guides
1 parent 78b7dec commit bc45486

File tree

4 files changed

+101
-261
lines changed

4 files changed

+101
-261
lines changed

LICENSE

+21-201
Original file line numberDiff line numberDiff line change
@@ -1,201 +1,21 @@
1-
Apache License
2-
Version 2.0, January 2004
3-
http://www.apache.org/licenses/
4-
5-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6-
7-
1. Definitions.
8-
9-
"License" shall mean the terms and conditions for use, reproduction,
10-
and distribution as defined by Sections 1 through 9 of this document.
11-
12-
"Licensor" shall mean the copyright owner or entity authorized by
13-
the copyright owner that is granting the License.
14-
15-
"Legal Entity" shall mean the union of the acting entity and all
16-
other entities that control, are controlled by, or are under common
17-
control with that entity. For the purposes of this definition,
18-
"control" means (i) the power, direct or indirect, to cause the
19-
direction or management of such entity, whether by contract or
20-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21-
outstanding shares, or (iii) beneficial ownership of such entity.
22-
23-
"You" (or "Your") shall mean an individual or Legal Entity
24-
exercising permissions granted by this License.
25-
26-
"Source" form shall mean the preferred form for making modifications,
27-
including but not limited to software source code, documentation
28-
source, and configuration files.
29-
30-
"Object" form shall mean any form resulting from mechanical
31-
transformation or translation of a Source form, including but
32-
not limited to compiled object code, generated documentation,
33-
and conversions to other media types.
34-
35-
"Work" shall mean the work of authorship, whether in Source or
36-
Object form, made available under the License, as indicated by a
37-
copyright notice that is included in or attached to the work
38-
(an example is provided in the Appendix below).
39-
40-
"Derivative Works" shall mean any work, whether in Source or Object
41-
form, that is based on (or derived from) the Work and for which the
42-
editorial revisions, annotations, elaborations, or other modifications
43-
represent, as a whole, an original work of authorship. For the purposes
44-
of this License, Derivative Works shall not include works that remain
45-
separable from, or merely link (or bind by name) to the interfaces of,
46-
the Work and Derivative Works thereof.
47-
48-
"Contribution" shall mean any work of authorship, including
49-
the original version of the Work and any modifications or additions
50-
to that Work or Derivative Works thereof, that is intentionally
51-
submitted to Licensor for inclusion in the Work by the copyright owner
52-
or by an individual or Legal Entity authorized to submit on behalf of
53-
the copyright owner. For the purposes of this definition, "submitted"
54-
means any form of electronic, verbal, or written communication sent
55-
to the Licensor or its representatives, including but not limited to
56-
communication on electronic mailing lists, source code control systems,
57-
and issue tracking systems that are managed by, or on behalf of, the
58-
Licensor for the purpose of discussing and improving the Work, but
59-
excluding communication that is conspicuously marked or otherwise
60-
designated in writing by the copyright owner as "Not a Contribution."
61-
62-
"Contributor" shall mean Licensor and any individual or Legal Entity
63-
on behalf of whom a Contribution has been received by Licensor and
64-
subsequently incorporated within the Work.
65-
66-
2. Grant of Copyright License. Subject to the terms and conditions of
67-
this License, each Contributor hereby grants to You a perpetual,
68-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69-
copyright license to reproduce, prepare Derivative Works of,
70-
publicly display, publicly perform, sublicense, and distribute the
71-
Work and such Derivative Works in Source or Object form.
72-
73-
3. Grant of Patent License. Subject to the terms and conditions of
74-
this License, each Contributor hereby grants to You a perpetual,
75-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76-
(except as stated in this section) patent license to make, have made,
77-
use, offer to sell, sell, import, and otherwise transfer the Work,
78-
where such license applies only to those patent claims licensable
79-
by such Contributor that are necessarily infringed by their
80-
Contribution(s) alone or by combination of their Contribution(s)
81-
with the Work to which such Contribution(s) was submitted. If You
82-
institute patent litigation against any entity (including a
83-
cross-claim or counterclaim in a lawsuit) alleging that the Work
84-
or a Contribution incorporated within the Work constitutes direct
85-
or contributory patent infringement, then any patent licenses
86-
granted to You under this License for that Work shall terminate
87-
as of the date such litigation is filed.
88-
89-
4. Redistribution. You may reproduce and distribute copies of the
90-
Work or Derivative Works thereof in any medium, with or without
91-
modifications, and in Source or Object form, provided that You
92-
meet the following conditions:
93-
94-
(a) You must give any other recipients of the Work or
95-
Derivative Works a copy of this License; and
96-
97-
(b) You must cause any modified files to carry prominent notices
98-
stating that You changed the files; and
99-
100-
(c) You must retain, in the Source form of any Derivative Works
101-
that You distribute, all copyright, patent, trademark, and
102-
attribution notices from the Source form of the Work,
103-
excluding those notices that do not pertain to any part of
104-
the Derivative Works; and
105-
106-
(d) If the Work includes a "NOTICE" text file as part of its
107-
distribution, then any Derivative Works that You distribute must
108-
include a readable copy of the attribution notices contained
109-
within such NOTICE file, excluding those notices that do not
110-
pertain to any part of the Derivative Works, in at least one
111-
of the following places: within a NOTICE text file distributed
112-
as part of the Derivative Works; within the Source form or
113-
documentation, if provided along with the Derivative Works; or,
114-
within a display generated by the Derivative Works, if and
115-
wherever such third-party notices normally appear. The contents
116-
of the NOTICE file are for informational purposes only and
117-
do not modify the License. You may add Your own attribution
118-
notices within Derivative Works that You distribute, alongside
119-
or as an addendum to the NOTICE text from the Work, provided
120-
that such additional attribution notices cannot be construed
121-
as modifying the License.
122-
123-
You may add Your own copyright statement to Your modifications and
124-
may provide additional or different license terms and conditions
125-
for use, reproduction, or distribution of Your modifications, or
126-
for any such Derivative Works as a whole, provided Your use,
127-
reproduction, and distribution of the Work otherwise complies with
128-
the conditions stated in this License.
129-
130-
5. Submission of Contributions. Unless You explicitly state otherwise,
131-
any Contribution intentionally submitted for inclusion in the Work
132-
by You to the Licensor shall be under the terms and conditions of
133-
this License, without any additional terms or conditions.
134-
Notwithstanding the above, nothing herein shall supersede or modify
135-
the terms of any separate license agreement you may have executed
136-
with Licensor regarding such Contributions.
137-
138-
6. Trademarks. This License does not grant permission to use the trade
139-
names, trademarks, service marks, or product names of the Licensor,
140-
except as required for reasonable and customary use in describing the
141-
origin of the Work and reproducing the content of the NOTICE file.
142-
143-
7. Disclaimer of Warranty. Unless required by applicable law or
144-
agreed to in writing, Licensor provides the Work (and each
145-
Contributor provides its Contributions) on an "AS IS" BASIS,
146-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147-
implied, including, without limitation, any warranties or conditions
148-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149-
PARTICULAR PURPOSE. You are solely responsible for determining the
150-
appropriateness of using or redistributing the Work and assume any
151-
risks associated with Your exercise of permissions under this License.
152-
153-
8. Limitation of Liability. In no event and under no legal theory,
154-
whether in tort (including negligence), contract, or otherwise,
155-
unless required by applicable law (such as deliberate and grossly
156-
negligent acts) or agreed to in writing, shall any Contributor be
157-
liable to You for damages, including any direct, indirect, special,
158-
incidental, or consequential damages of any character arising as a
159-
result of this License or out of the use or inability to use the
160-
Work (including but not limited to damages for loss of goodwill,
161-
work stoppage, computer failure or malfunction, or any and all
162-
other commercial damages or losses), even if such Contributor
163-
has been advised of the possibility of such damages.
164-
165-
9. Accepting Warranty or Additional Liability. While redistributing
166-
the Work or Derivative Works thereof, You may choose to offer,
167-
and charge a fee for, acceptance of support, warranty, indemnity,
168-
or other liability obligations and/or rights consistent with this
169-
License. However, in accepting such obligations, You may act only
170-
on Your own behalf and on Your sole responsibility, not on behalf
171-
of any other Contributor, and only if You agree to indemnify,
172-
defend, and hold each Contributor harmless for any liability
173-
incurred by, or claims asserted against, such Contributor by reason
174-
of your accepting any such warranty or additional liability.
175-
176-
END OF TERMS AND CONDITIONS
177-
178-
APPENDIX: How to apply the Apache License to your work.
179-
180-
To apply the Apache License to your work, attach the following
181-
boilerplate notice, with the fields enclosed by brackets "{}"
182-
replaced with your own identifying information. (Don't include
183-
the brackets!) The text should be enclosed in the appropriate
184-
comment syntax for the file format. We also recommend that a
185-
file or class name and description of purpose be included on the
186-
same "printed page" as the copyright notice for easier
187-
identification within third-party archives.
188-
189-
Copyright {yyyy} {name of copyright owner}
190-
191-
Licensed under the Apache License, Version 2.0 (the "License");
192-
you may not use this file except in compliance with the License.
193-
You may obtain a copy of the License at
194-
195-
http://www.apache.org/licenses/LICENSE-2.0
196-
197-
Unless required by applicable law or agreed to in writing, software
198-
distributed under the License is distributed on an "AS IS" BASIS,
199-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200-
See the License for the specific language governing permissions and
201-
limitations under the License.
1+
MIT License
2+
3+
Copyright (c) 2021 CloudWebManage
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ is kept securely regardless of the status of the Minio server, or usage.
1010
The following sections provides the documentation for the end-users of the CWM
1111
Object Storage solution:
1212

13+
- [How To Guides](objectstorage/howto.md)
1314
- [Console](objectstorage/console.md)
1415
- [CLI](objectstorage/cli.md)
1516
- SDKs:

objectstorage/console.md

+11-60
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
11
# Object Storage Management Console
22

3+
<!--
4+
To update the TOC:
5+
* install nodejs (https://nodejs.org/en/)
6+
* run the following command:
7+
* npx [email protected] --github --notitle objectstorage/console.md
8+
-->
9+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
10+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
11+
312
- [Overview](#overview)
413
- [Management Console: Features](#management-console-features)
514
- [Management Console: Object Storage](#management-console-object-storage)
615
- [Object Storage: Buckets Stores](#object-storage-buckets-stores)
716
- [Object Storage: Gateway & Cache](#object-storage-gateway--cache)
817
- [Object Storage: Pricing](#object-storage-pricing)
918
- [Object Storage: Documentation](#object-storage-documentation)
10-
- [Management Console: How-Tos](#management-console-how-tos)
11-
- [Management Console: How to create an instance](#management-console-how-to-create-an-instance)
12-
- [Management Console: How to configure an instance](#management-console-how-to-configure-an-instance)
13-
- [Management Console: How to delete an instance](#management-console-how-to-delete-an-instance)
19+
20+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1421

1522
## Overview
1623

@@ -73,62 +80,6 @@ its **Buckets Stores** and **Gateway & Cache** offerings.
7380
The **Documentation** section provides the help on how to configure and use the
7481
CWM Object Storage.
7582

76-
## Management Console: How-Tos
77-
78-
The following how-tos provide the general insights into the usage of CWM Object
79-
Storage Management Console:
80-
81-
### Management Console: How to create an instance
82-
83-
- Make sure that you're logged in.
84-
- From the left panel, select **Object Storage** > **Buckets Stores**.
85-
- From the right side, click on **Add Instance** button. A dialog box will
86-
appear.
87-
- Select **Zone** from the drop-down list.
88-
- Type in the **Instance Name**.
89-
- Click on the **Add Instance** button.
90-
- The new instance will appear on the right side.
91-
92-
Demo:
93-
94-
![Create Instance Demo](images/console/demo-create-instance.gif)
95-
96-
### Management Console: How to configure an instance
97-
98-
- Click on the **Open** button
99-
![Open](images/console/btn-open.png) of the instance that
100-
you want to configure.
101-
- A new panel will appear on the right side showing all the properties and
102-
configurations of the selected instance. The right expanded panel will include
103-
the following tabs/sub-menus:
104-
105-
- INFO
106-
- CONFIGURE
107-
- CACHE
108-
- REPORTS
109-
- LOGS
110-
111-
- The expanded right panel of an instance can be closed by clicking on the
112-
**Close** button ![Close](images/console/btn-close.png).
113-
114-
Demo:
115-
116-
![Configure Instance](images/console/demo-configure-instance.gif)
117-
118-
### Management Console: How to delete an instance
119-
120-
- Click on the **Actions** button
121-
![Actions](images/console/btn-actions.png) on the instance
122-
you want to delete.
123-
- From the drop-down menu, select the **Terminate** menu option. A confirmation
124-
dialog box will appear.
125-
- Check on the **Check to allow Termination** checkbox.
126-
- Click on the **Terminate Instance** button.
127-
128-
Demo:
129-
130-
![Delete Instance Demo](images/console/demo-delete-instance.gif)
131-
13283
---
13384

13485
**NOTE**: This documentation aims to provide an up-to-date overview of the CWM

objectstorage/howto.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Object Storage How To Guides
2+
3+
<!--
4+
To update the TOC:
5+
* install nodejs (https://nodejs.org/en/)
6+
* run the following command:
7+
* npx [email protected] --github --notitle objectstorage/howto.md
8+
-->
9+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
10+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
11+
12+
- [Create an instance](#create-an-instance)
13+
- [Configure an instance](#configure-an-instance)
14+
- [Delete an instance](#delete-an-instance)
15+
16+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
17+
18+
19+
## Create an instance
20+
21+
- Make sure that you're logged in to the management console.
22+
- From the left panel, select **Object Storage** > **Buckets Stores**.
23+
- From the right side, click on **Add Instance** button. A dialog box will
24+
appear.
25+
- Select **Zone** from the drop-down list.
26+
- Type in the **Instance Name**.
27+
- Click on the **Add Instance** button.
28+
- The new instance will appear on the right side.
29+
30+
Demo:
31+
32+
![Create Instance Demo](images/console/demo-create-instance.gif)
33+
34+
## Configure an instance
35+
36+
- Click on the **Open** button
37+
![Open](images/console/btn-open.png) of the instance that
38+
you want to configure.
39+
- A new panel will appear on the right side showing all the properties and
40+
configurations of the selected instance. The right expanded panel will include
41+
the following tabs/sub-menus:
42+
43+
- INFO
44+
- CONFIGURE
45+
- CACHE
46+
- REPORTS
47+
- LOGS
48+
49+
- The expanded right panel of an instance can be closed by clicking on the
50+
**Close** button ![Close](images/console/btn-close.png).
51+
52+
Demo:
53+
54+
![Configure Instance](images/console/demo-configure-instance.gif)
55+
56+
## Delete an instance
57+
58+
- Click on the **Actions** button
59+
![Actions](images/console/btn-actions.png) on the instance
60+
you want to delete.
61+
- From the drop-down menu, select the **Terminate** menu option. A confirmation
62+
dialog box will appear.
63+
- Check on the **Check to allow Termination** checkbox.
64+
- Click on the **Terminate Instance** button.
65+
66+
Demo:
67+
68+
![Delete Instance Demo](images/console/demo-delete-instance.gif)

0 commit comments

Comments
 (0)