Skip to content

Commit b8475fa

Browse files
authored
[Docs] Incorporate review changes. (#6)
* [Docs] Incorporate review changes. Signed-off-by: Azeem Sajid <[email protected]> * Remove extra nested images directory. * [Docs: CLI] Fix nomenclature. * [Docs: CLI] Remove some docs. Add links to the official docs.
1 parent 22588ec commit b8475fa

22 files changed

+144
-408
lines changed

objectstorage/cli.md

Lines changed: 50 additions & 246 deletions
Large diffs are not rendered by default.

objectstorage/console.md

Lines changed: 67 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -1,142 +1,102 @@
1-
# Object Storage Console
1+
# Object Storage Management Console
22

33
- [Overview](#overview)
4-
- [Object Storage Console: Features](#object-storage-console-features)
5-
- [Object Storage Console: Dashboard](#object-storage-console-dashboard)
6-
- [Object Storage Console: Object Storage](#object-storage-console-object-storage)
4+
- [Management Console: Features](#management-console-features)
5+
- [Management Console: Object Storage](#management-console-object-storage)
76
- [Object Storage: Buckets Stores](#object-storage-buckets-stores)
87
- [Object Storage: Gateway & Cache](#object-storage-gateway--cache)
98
- [Object Storage: Pricing](#object-storage-pricing)
109
- [Object Storage: Documentation](#object-storage-documentation)
11-
- [Object Storage Console: Billing](#object-storage-console-billing)
12-
- [Billing: Usage Reports](#billing-usage-reports)
13-
- [Object Storage Console: User Profile](#object-storage-console-user-profile)
14-
- [Object Storage Console: How-Tos](#object-storage-console-how-tos)
15-
- [Object Storage Console: How to log in](#object-storage-console-how-to-log-in)
16-
- [Object Storage Console: How to navigate through Dashboard](#object-storage-console-how-to-navigate-through-dashboard)
17-
- [Object Storage Console: How to create a MinIO Instance](#object-storage-console-how-to-create-a-minio-instance)
18-
- [Object Storage Console: How to delete a MinIO Instance](#object-storage-console-how-to-delete-a-minio-instance)
19-
- [Object Storage Console: How to configure a MinIO Instance](#object-storage-console-how-to-configure-a-minio-instance)
20-
- [MinIO Console: Features](#minio-console-features)
21-
- [MinIO Console: How-Tos](#minio-console-how-tos)
22-
- [MinIO Console: How to log in via CWM MinIO Instance Credentials](#minio-console-how-to-log-in-via-cwm-minio-instance-credentials)
10+
- [Management Console: User Profile](#management-console-user-profile)
11+
- [Management Console: Tasks Queue](#management-console-tasks-queue)
12+
- [Management Console: How-Tos](#management-console-how-tos)
13+
- [Management Console: How to create an instance](#management-console-how-to-create-an-instance)
14+
- [Management Console: How to configure an instance](#management-console-how-to-configure-an-instance)
15+
- [Management Console: How to delete an instance](#management-console-how-to-delete-an-instance)
2316

2417
## Overview
2518

26-
The CWM Object Storage Console provides a simple and easy-to-use WebUI to make
27-
use of CWM Object Storage offerings. With the help of this Console, a user can
28-
easily manage the MinIO instances according to the workload requirements.
19+
The CWM Object Storage [Management Console](https://objectstorage.cloudwm.com/)
20+
provides a simple and easy-to-use WebUI to make use of CWM Object Storage
21+
offerings. Using the Management Console, users can easily manage the CWM Object
22+
Storage instances according to their workload requirements.
2923

30-
The following sections discuss all the available features of the Console (CWM
31-
Object Storage and MinIO instance) and how to use them effectively to make the
32-
most of Console/WebUI.
24+
Management Console:
3325

34-
**NOTE**: The terms Console and WebUI are used interchangeably throughout this
35-
documentation. However, please observe the distinction between CWM Object
36-
Storage Console/WebUI and MinIO's Console/WebUI.
26+
![Overview](images/console/cwm-object-storage/overview.png)
3727

3828
---
3929

40-
## Object Storage Console: Features
30+
## Management Console: Features
4131

42-
The left panel of the Console provides the major supported features:
32+
The left panel of the Management Console provides the supported features:
4333

44-
![Left Panel](images/console/cwm-object-storage/left-panel.png)
45-
46-
The following features are provided:
47-
48-
- Dashboard
4934
- Object Storage
5035
- Buckets Stores
5136
- Gateway & Cache
5237
- Pricing
5338
- Documentation
54-
- Billing
55-
- Usage Reports
56-
- User Profile
5739

58-
### Object Storage Console: Dashboard
40+
Left Panel:
5941

60-
The **Dashboard** is the first screen that you see after logging in to the
61-
Console. It provides a holistic view of all the MinIO instances, their health,
62-
usage statistics, etc. Also, the stats provided by the Dashboard can be used to
63-
create analytics reports for decision-making purposes.
42+
![Left Panel](images/console/cwm-object-storage/left-panel.png)
6443

65-
### Object Storage Console: Object Storage
44+
The Management Console also provides the **User Profile** and **Tasks Queue**
45+
features.
6646

67-
The **Object Storage** section from the left panel is the section that
68-
specifically provides the options related to object storage:
47+
### Management Console: Object Storage
6948

70-
- Object Storage
71-
- Buckets Stores
72-
- Gateway & Cache
73-
- Pricing
74-
- Documentation
49+
The **Object Storage** section from the left panel expands the supported
50+
features:
7551

7652
#### Object Storage: Buckets Stores
7753

78-
The Buckets Stores provides options to create, delete, configure, search, etc.
79-
the MioIO instances. The instance related options are available by clicking on
80-
the specific instance.
54+
The **Buckets Stores** feature allows the users to create, delete, configure,
55+
search, and perform other instance-related operations. The instance-related
56+
options are available by clicking on the specific instance.
57+
58+
Example:
8159

8260
![Buckets Stores' Overview](images/console/cwm-object-storage/buckets-stores-overview.png)
8361

8462
#### Object Storage: Gateway & Cache
8563

86-
The **Gateway & Cache** provides the option to choose between cloud storage
87-
alternatives for a CWM MinIO instance e.g. CloudWM, AWS S3, Azure Blob Store,
88-
Google Object Store. This makes it easy to migrate from on-prem MinIO infra to
89-
CWM without any vendor-locking of the object storage itself. This may also be
90-
helpful to create redundancy by configuring the multiple object storage
91-
solutions with the CWM MinIO instance.
64+
The **Gateway & Cache** feature provides the option to choose the alternative
65+
cloud storage providers such as CloudWM, AWS S3, Azure Blob Store, Google Object
66+
Store. This option makes it easy to migrate from on-prem infra to CWM without
67+
any vendor-locking of the object storage itself. This may also be helpful to
68+
create redundancy by configuring multiple object storage solutions with the CWM
69+
instances.
9270

9371
#### Object Storage: Pricing
9472

95-
The **Pricing** section provides the price structure for CWM Object Storage
96-
offerings for the MinIO's Buckets Stores, and Gateway & Cache.
73+
The **Pricing** feature provides the price structure for CWM Object Storage for
74+
its **Buckets Stores** and **Gateway & Cache** offerings.
9775

9876
#### Object Storage: Documentation
9977

100-
The **Documentation** section provides the help on configuring and the usage of
101-
the CWM Object Storage.
102-
103-
### Object Storage Console: Billing
78+
The **Documentation** section provides the help on how to configure and use the
79+
CWM Object Storage.
10480

105-
The **Billing** section provides an overview of the billed amount for the MinIO
106-
instances.
81+
### Management Console: User Profile
10782

108-
#### Billing: Usage Reports
83+
The **User Profile** feature provides the features to reset your password,
84+
enable/disable multi-factor authentication, configure your preferences, etc. You
85+
can navigate to your profile by clicking on the User Profile icon ![User Profile
86+
Icon](images/console/cwm-object-storage/user-profile-icon.png) in the top-right
87+
corner.
10988

110-
Under the **Usage Reports** section, you can see the billing summaries, filter
111-
them according to dates, and export in CSV format.
89+
### Management Console: Tasks Queue
11290

113-
### Object Storage Console: User Profile
91+
The **Tasks Queue** feature of the Management Console helps you keep track of
92+
the multiple parallel tasks.
11493

115-
The Console provides the features to reset your password, enable/disable
116-
multi-factor authentication, configure your preferences, etc. You can navigate
117-
to your profile by clicking on the User Profile icon
118-
![User Profile Icon](images/console/cwm-object-storage/user-profile-icon.png)
119-
in the top-right corner.
120-
121-
## Object Storage Console: How-Tos
94+
## Management Console: How-Tos
12295

12396
The following how-tos provide the general insights into the usage of CWM Object
124-
Storage Console:
125-
126-
### Object Storage Console: How to log in
127-
128-
- Log in to [Object Storage Console](https://objectstorage.cloudwm.com/login).
129-
130-
![Log in screen](images/console/cwm-object-storage/log-in-screen.png)
131-
132-
- Enter your credentials or log in with the other available options e.g. Google,
133-
Facebook, or GitHub.
134-
135-
### Object Storage Console: How to navigate through Dashboard
97+
Storage Management Console:
13698

137-
TODO: Add details
138-
139-
### Object Storage Console: How to create a MinIO Instance
99+
### Management Console: How to create an instance
140100

141101
- Make sure that you're logged in.
142102
- From the left panel, select **Object Storage** > **Buckets Stores**.
@@ -145,34 +105,20 @@ TODO: Add details
145105
- Select **Zone** from the drop-down list.
146106
- Type in the **Instance Name**.
147107
- Click on the **Add Instance** button.
148-
- The new MinIO instance will appear on the right side.
108+
- The new instance will appear on the right side.
149109

150110
Demo:
151111

152112
![Create Instance Demo](images/console/cwm-object-storage/demo-create-instance.gif)
153113

154-
### Object Storage Console: How to delete a MinIO Instance
155-
156-
- Click on the **Actions** button
157-
![Actions](images/console/cwm-object-storage/btn-actions.png) on the instance
158-
you want to delete.
159-
- From the drop-down menu, select the **Terminate** menu option. A confirmation
160-
dialog box will appear.
161-
- Check on the **Check to allow Termination** checkbox.
162-
- Click on the **Terminate Instance** button.
163-
164-
Demo:
165-
166-
![Delete Instance Demo](images/console/cwm-object-storage/demo-delete-instance.gif)
167-
168-
### Object Storage Console: How to configure a MinIO Instance
114+
### Management Console: How to configure an instance
169115

170116
- Click on the **Open** button
171-
![Open](images/console/cwm-object-storage/btn-open.png) of the MinIO instance
172-
that you want to configure.
117+
![Open](images/console/cwm-object-storage/btn-open.png) of the instance that
118+
you want to configure.
173119
- A new panel will appear on the right side showing all the properties and
174-
configurations of the selected MinIO instance. The right expanded panel will
175-
include the following tabs/sub-menus:
120+
configurations of the selected instance. The right expanded panel will include
121+
the following tabs/sub-menus:
176122

177123
- INFO
178124
- CONFIGURE
@@ -187,42 +133,24 @@ Demo:
187133

188134
![Configure Instance](images/console/cwm-object-storage/demo-configure-instance.gif)
189135

190-
---
191-
192-
The following sections explore the features and usage of the CWM MinIO instance
193-
available via CWM Object Storage offerings:
194-
195-
## MinIO Console: Features
196-
197-
The MinIO Console (Object Browser) provides a minimal WebUI to:
198-
199-
- create/remove buckets,
200-
- upload/download objects; and,
201-
- share the objects.
136+
### Management Console: How to delete an instance
202137

203-
This WebUI is pretty intuitive. A typical user can easily explore all its
204-
options in a matter of minutes and start building solutions on top of it.
205-
206-
## MinIO Console: How-Tos
207-
208-
The following how-tos provide the general insights into the usage of CWM MinIO
209-
instance Console (Object Browser):
210-
211-
### MinIO Console: How to log in via CWM MinIO Instance Credentials
212-
213-
- You need the MinIO instance URL, Access Key, and Secret Key to log in. You can
214-
get these from the **INFO** tab of a MinIO instance.
215-
- Open the URL in a browser.
216-
- Log in by providing the Access and Secret keys.
138+
- Click on the **Actions** button
139+
![Actions](images/console/cwm-object-storage/btn-actions.png) on the instance
140+
you want to delete.
141+
- From the drop-down menu, select the **Terminate** menu option. A confirmation
142+
dialog box will appear.
143+
- Check on the **Check to allow Termination** checkbox.
144+
- Click on the **Terminate Instance** button.
217145

218146
Demo:
219147

220-
![MinIO Instance Console](images/console/cwm-object-storage/demo-minio-instance-login.gif)
148+
![Delete Instance Demo](images/console/cwm-object-storage/demo-delete-instance.gif)
221149

222150
---
223151

224152
**NOTE**: This documentation aims to provide an up-to-date overview of the CWM
225-
Object Storage Console and its supported MinIO instances. In case of any
153+
Object Storage Management Console and its supported instances. In case of any
226154
discrepancies, please do contact support or
227155
[open an issue](https://github.com/CloudWebManage/cwm-users-documentation/issues/new/choose)
228156
on its [GitHub repository](https://github.com/CloudWebManage/cwm-users-documentation)
Loading
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)