Skip to content
This repository was archived by the owner on Jul 22, 2024. It is now read-only.

Commit 4d693ef

Browse files
committed
fix lint issues
1 parent 5af2a1a commit 4d693ef

File tree

12 files changed

+296
-279
lines changed

12 files changed

+296
-279
lines changed

workshop/Lab5/README.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Object Storage with Kubernetes
1+
# Object Storage with Kubernetes
22

33
## About Object Storage
44

@@ -7,52 +7,56 @@ In `object storage` or `Object-based Storage Devices (OSD)`, data is organized i
77
Object storage also provides programmatic interfaces (mostly RESTful APIs) to manipulate data for CRUD, versioning, replication, life-cycle management and data transfer. Applications don't need to go through an operating system's storage drivers to manipulate data, they simply send `get`, `put`, or `delete` requests to the storage system.
88

99
Object storage has the following benefits:
10+
1011
1. durable, built-in data integrity (e.g. in case of disk failure),
11-
2. available, highly available via REST APIs at the manager layer,
12-
3. scalable, in order of terabytes (TBs), petabytes (PBs), and greater, unavailable in file or block storage,
13-
4. flexible, access from anywhere via REST APIs,
14-
5. secure, encrypt at-rest and in-transit.
12+
1. available, highly available via REST APIs at the manager layer,
13+
1. scalable, in order of terabytes (TBs), petabytes (PBs), and greater, unavailable in file or block storage,
14+
1. flexible, access from anywhere via REST APIs,
15+
1. secure, encrypt at-rest and in-transit.
1516

1617
### Usage
1718

18-
Object storage is often used for handling large amounts of unstructured data, including email, video, photos, web pages, audio, sensor data and other types of media and web content, both textual and non-textual.
19+
Object storage is often used for handling large amounts of unstructured data, including email, video, photos, web pages, audio, sensor data and other types of media and web content, both textual and non-textual.
1920

2021
Use cases are:
22+
2123
1. Disaster recovery (DR) and backup (BC),
22-
2. AI and analytics, as a data lake in combination with Spark and Tensorflow,
23-
3. cloud native, startups combining cost-effectiveness of cloud native with flexibility of object storage,
24-
4. data archive, e.g. media files.
24+
1. AI and analytics, as a data lake in combination with Spark and Tensorflow,
25+
1. cloud native, startups combining cost-effectiveness of cloud native with flexibility of object storage,
26+
1. data archive, e.g. media files.
2527

2628
### Standards
2729

2830
The International Committee for Information Technology Standards (INCITS) is an American standards organization for computer and communications standards. Its [T10 committee](http://www.t10.org) is devoted to Small Computer Systems Interface (SCSI) technology and this T10 committee has published 2 standards for Object-Based Storage Devices (OSD):
31+
2932
* Object-Based Storage Device Commands (OSD), INCITS 400-2004 (R2013), InterNational Committee for Information Technology Standards. Retrieved 8 November 2013.
3033
* Object-Based Storage Devices - 2 (OSD-2), INCITS 458-2011 (R2016), InterNational Committee for Information Technology Standards. 15 March 2011. Retrieved 8 November 2013.
3134

3235
## About IBM Cloud Object Storage
3336

3437
The IBM Cloud Object Storage (COS) offers a few features that help secure your data. IBM Cloud Object Storage (COS) actively participates in several industry compliance programs and provides the following compliance, certifications, attestations, or reports as measure of proof:
35-
- ISO 27001,
36-
- PCI-DSS for Payment Card Industry (PCI) USA,
37-
- HIPAA for Healthcare USA, (including administrative, physical, and technical safeguards required of Business Associates in 45 CFR Part 160 and Subparts A and C of Part 164),
38-
- ISO 22301 Business Continuity Management,
39-
- ISO 27017,
40-
- ISO 27018,
41-
- ISO 31000 Risk Management Principles,
42-
- ISO 9001 Quality Management System,
43-
- SOC1 Type 2 (SSAE 16), (System and Organization Controls 1),
44-
- SOC2 Type 2 (SSAE 16), (System and Organization Controls 2),
45-
- CSA STAR Level 1 (Self-Assessment),
46-
- General Data Protection Regulation (GDPR) ready,
47-
- Privacy shield certified.
38+
39+
* ISO 27001,
40+
* PCI-DSS for Payment Card Industry (PCI) USA,
41+
* HIPAA for Healthcare USA, (including administrative, physical, and technical safeguards required of Business Associates in 45 CFR Part 160 and Subparts A and C of Part 164),
42+
* ISO 22301 Business Continuity Management,
43+
* ISO 27017,
44+
* ISO 27018,
45+
* ISO 31000 Risk Management Principles,
46+
* ISO 9001 Quality Management System,
47+
* SOC1 Type 2 (SSAE 16), (System and Organization Controls 1),
48+
* SOC2 Type 2 (SSAE 16), (System and Organization Controls 2),
49+
* CSA STAR Level 1 (Self-Assessment),
50+
* General Data Protection Regulation (GDPR) ready,
51+
* Privacy shield certified.
4852

4953
At a high level, information on `IBM Cloud Object Storage (COS)` is encrypted, then dispersed across multiple geographic locations, and accessed over popular protocols like HTTP with a RESTful API.
5054

51-
`SecureSlice` distributes the data in slices across geo locations so that no full copy of data exists on any individual storage node, and automatically encrypts each segment of data before it is erasure coded and dispersed.
55+
`SecureSlice` distributes the data in slices across geo locations so that no full copy of data exists on any individual storage node, and automatically encrypts each segment of data before it is erasure coded and dispersed.
5256

53-
The content can only be re-assembled through IBM Cloud’s `Accesser` technology at the client’s primary data center, where the data was originally received, and decrypted again by `SecureSlice`.
57+
The content can only be re-assembled through IBM Cloud’s `Accesser` technology at the client’s primary data center, where the data was originally received, and decrypted again by `SecureSlice`.
5458

55-
`Data-in-place` or `data-at-rest` security is ensured when you persist database contents in IBM Cloud Object Storage.
59+
`Data-in-place` or `data-at-rest` security is ensured when you persist database contents in IBM Cloud Object Storage.
5660

5761
You also have a choice to use integration capabilities with IBM Cloud Key Management Services like `IBM Key Protect` (using FIPS 140-2 Level 3 certified hardware security modules (HSMs)) and `Hyper Protect Crypto Services` (built on FIPS 140-2 Level 4-certified hardware) for enhanced security features and compliance.
5862

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
# Configure your Cluster
22

33
You now have an Object Storage instance with a bucket, and have found the corresponding private endpoint for your Object Storage. Next, we can configure a Kubernetes cluster:
4+
45
1. Create a New Namespace in your Cluster,
56
2. Create a Secret to Access the Object Storage,
67

78
## Create a New Namespace in your Cluster
89

910
1. Previously, you logged in to your personal account to create a free instance of IBM Cloud Object Storage (COS). If the cluster exists in a different account, make sure to to switch accounts and log in to the IBM Cloud where your cluster exists.
1011

11-
```
12+
```console
1213
ibmcloud login -u $IBM_ID
1314
```
1415

1516
**Note:** if you use a single-sign-on provider, use the `-sso` flag.
1617

1718
2. If you needed to switch accounts, you will have logged in again, and when prompted to `Select an account`, this time, choose the account with your cluster. In the example below, I have to choose account number **2** from the list, `2. IBM Client Developer Advocacy (e65910fa61) <-> 1234567`,
1819

19-
```
20+
```console
2021
ibmcloud login -u b.newell2@remkoh.dev
2122
API endpoint: https://cloud.ibm.com
2223
Region: us-south
@@ -34,13 +35,13 @@ You now have an Object Storage instance with a bucket, and have found the corres
3435

3536
3. Retrieve your cluster information.
3637

37-
```
38+
```console
3839
ibmcloud ks clusters
3940
```
4041

41-
outputs,
42+
outputs,
4243

43-
```
44+
```console
4445
$ ibmcloud ks clusters
4546

4647
Name ID State Created Workers Location Version Resource Group Name Provider
@@ -49,30 +50,31 @@ You now have an Object Storage instance with a bucket, and have found the corres
4950

5051
4. Retrieve the name of your cluster, in this example, I set the name of the first cluster with index `0`,
5152

52-
```
53+
```console
5354
CLUSTER_NAME=$(ibmcloud ks clusters --output json | jq -r '.[0].name')
5455
echo $CLUSTER_NAME
5556
```
5657

57-
5. **In your browser:** get the login command for your cluster:
58-
1. Go to the IBM Cloud resources page at https://cloud.ibm.com/resources,
58+
5. **In your browser:** get the login command for your cluster:
59+
60+
1. Go to the IBM Cloud resources page at https://cloud.ibm.com/resources,
5961
Under `Clusters` find and select your cluster, and load the cluster overview page. There are two ways to retrieve the login command with token:
6062
1. Click the `Actions` drop down next to the `OpenShift web console` button, and select `Connect via CLI`, in the pop-up window, click the `oauth token request page` link, or
61-
2. Click `OpenShift web console` button, in the `OpenShift web console`, click your profile name, such as IAM#name@email.com, and then click `Copy Login Command`.
63+
1. Click `OpenShift web console` button, in the `OpenShift web console`, click your profile name, such as IAM#name@email.com, and then click `Copy Login Command`.
6264

6365
![Copy Login Command](../images/cluster/ocp_copylogincommand.png)
6466

65-
In the new page that opens for both options, click `Display Token`,
66-
67+
In the new page that opens for both options, click `Display Token`,
68+
6769
![Display Token](../images/cluster/ocp_displaytoken.png)
68-
69-
Copy the `oc login` command,
70-
70+
71+
Copy the `oc login` command,
72+
7173
![Copy oc login](../images/cluster/ocp_copy_oclogin.png)
72-
74+
7375
and paste the command into your terminal.
7476

75-
```
77+
```console
7678
$ oc login --token=HjXc6nNGyCB1imhqtc9csTmGQ5obrPcoe4SRJqTnnT8 --server=https://c100-e.us-south.containers.cloud.ibm.com:30712
7779
Logged into "https://c100-e.us-south.containers.cloud.ibm.com:30712" as "IAM#b.newell2@remkoh.dev" using the token provided.
7880

@@ -82,36 +84,36 @@ You now have an Object Storage instance with a bucket, and have found the corres
8284
Welcome! See 'oc help' to get started.
8385
```
8486

85-
6. Create a new project `cos-with-s3fs`
87+
6. Create a new project `cos-with-s3fs`,
8688

87-
```
89+
```console
8890
oc new-project $NAMESPACE
8991
```
9092

9193
7. Make sure you're still logged in to your cluster and namespace,
9294

93-
```
95+
```console
9496
oc project
95-
97+
9698
Using project "cos-with-s3fs"
9799
```
98100

99101
## Create a Secret to Access the Object Storage
100102

101103
1. Create a `Kubernetes Secret` to store the COS service credentials named `cos-write-access`.
102104

103-
```
105+
```console
104106
oc create secret generic cos-write-access --type=ibm/ibmc-s3fs --from-literal=api-key=$COS_APIKEY --from-literal=service-instance-id=$COS_GUID
105107
```
106108

107109
outputs,
108110

109-
```
111+
```console
110112
$ oc create secret generic cos-write-access --type=ibm/ibmc-s3fs --from-literal=api-key=$COS_APIKEY --from-literal=service-instance-id=$COS_GUID
111113

112114
secret/cos-write-access created
113115
```
114116

115117
## Next
116118

117-
[Setup the Cloud Object Storage plugin](COS-PLUGIN.md)
119+
[Setup the Cloud Object Storage plugin](COS-PLUGIN.md)

0 commit comments

Comments
 (0)