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

Commit 78edbae

Browse files
authored
Merge branch 'master' into master
2 parents 9291c81 + 5e6f1ca commit 78edbae

File tree

87 files changed

+2495
-226
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+2495
-226
lines changed

.github/workflows/ci.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: ci
2+
on:
3+
push:
4+
branches:
5+
- main
6+
- master
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- uses: actions/setup-python@v2
13+
with:
14+
python-version: 3.x
15+
- run: pip install mkdocs-material
16+
- run: mkdocs gh-deploy --force

.markdownlint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"line-length": false
2+
"line-length": false,
3+
"MD046": false
34
}

.markdownlintignore

Lines changed: 0 additions & 2 deletions
This file was deleted.

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ node_js: 10
55
before_script:
66
- npm install markdownlint-cli
77
script:
8-
- markdownlint -c .markdownlint.json workshop
8+
- markdownlint -c .markdownlint.json workshop --ignore workshop/SUMMARY.md

README.md

Lines changed: 3 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,5 @@
1-
# Advocacy Workshop
2-
3-
This is a template for workshops hosted on Gitbook. To view it online, go to:
4-
5-
<https://ibm-developer.gitbook.io/workshop-template/>
6-
7-
Create a new repo based off this template, and use the folowing folders as a guide:
8-
9-
```ini
10-
11-
- data (any data (CSV, JSON, etc files) to be used)
12-
- notebooks (any Jupyter notebooks can go here)
13-
- src (any application source code can go here)
14-
- workshop (this is where the workshop is documented)
15-
|_ .gitbook (images should go here)
16-
|_ <folder-n> (these are exercises for the workshop)
17-
|_README.md (the steps for the exercise, in Markdown)
18-
|_ README.md (this will appear on the gitbook home page)
19-
|_ SUMMARY.md (this dictates the Table of Contents)
20-
.gitbook.yaml (tells GitBook to only read the stuff in 'workshop')
21-
.travis.yaml (runs markdownlint by default)
22-
README.md (only used for GitHub.com)
23-
```
24-
25-
## Tips and conventions
26-
27-
### Screenshots
28-
29-
Screenshots look better if they are full page.
30-
Use [ImageMagick](https://imagemagick.org) to create a nice border around images with this command:
31-
32-
```bash
33-
magick mogrify -bordercolor gray -border 2
34-
```
35-
36-
### Design in GitBook
37-
38-
To ensure a common design for IBM workshops please use following options:
39-
40-
* Select in `Theme & Colors` the theme: `Bold` and the color: `#1C6DBC`
41-
42-
![](workshop/.gitbook/generic/gitbook-theme-and-color.png)
43-
44-
* Select in `Logo & Title` the IBM logo
45-
46-
![](workshop/.gitbook/generic/gitbook-logo.png)
47-
48-
### Understand the major GitBook template structure
49-
50-
It is useful to understand the used GitBook structure of this [template](https://docs.gitbook.com/integrations/github/content-configuration#structure).
51-
52-
* [README.md](https://docs.gitbook.com/integrations/github/content-configuration#structure): Each README.md dictates the Table of Contents on the right hand side.
53-
* [SUMMARY.md](https://docs.gitbook.com/integrations/github/content-configuration#summary): This dictates the Table of Contents on the left hand side.
54-
* [root](https://docs.gitbook.com/integrations/github/content-configuration#root): Path to lookup for your documentation defaults to the root directory of the repository.
55-
* [.gitbook.yaml](https://docs.gitbook.com/integrations/github/content-configuration): You can configure how GitBook should parse your Git repository using the.gitbook.yaml file that must rely on the root of your repository.
56-
57-
The image shows the file names and thier resonsibilities.
58-
59-
![](workshop/.gitbook/generic/gitbook-mainstructure.png)
1+
# Kubernetes Storage Workshop
602

3+
This is the source repository for a workshop about Storage when using Kubernetes. To view it online, go to:
614

5+
<https://ibm.github.io/kube-storage101>

data/images/gb1.jpg

-3.23 KB
Loading

data/images/gb2.jpg

-1.84 KB
Loading

data/images/gb3.jpg

-2.42 KB
Loading

mkdocs.yml

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Project information
2+
site_name: Kubernetes Storage 101
3+
site_url: https://ibm.github.io/kube-storage101
4+
site_author: IBM Developer
5+
6+
# Repository
7+
repo_name: kube-storage101
8+
repo_url: https://github.com/ibm/kube-storage101
9+
edit_uri: edit/master/docs
10+
docs_dir: workshop
11+
12+
# Navigation
13+
nav:
14+
- Welcome:
15+
- About the workshop: README.md
16+
- Workshop:
17+
- Lab 0. Prework: Lab0/README.md
18+
- Lab 1. Container Storage and Kubernetes: Lab1/README.md
19+
- Lab 2. File Storage with Kubernetes: Lab2/README.md
20+
- Lab 3. Block Storage with Kubernetes: Lab3/README.md
21+
- Lab 4. Kubernetes StatefulSets: Lab4/README.md
22+
- Lab 5. Object Storage with Kubernetes: Lab5/README.md
23+
24+
## DO NOT CHANGE BELOW THIS LINE
25+
26+
# Copyright
27+
copyright: Copyright &copy; 2020 IBM Developer
28+
29+
# Theme
30+
theme:
31+
name: material
32+
font:
33+
text: IBM Plex Sans
34+
code: IBM Plex Mono
35+
icon:
36+
logo: material/library
37+
features:
38+
- navigation.tabs
39+
#- navigation.instant
40+
palette:
41+
scheme: default
42+
primary: blue
43+
accent: blue
44+
45+
# Plugins
46+
plugins:
47+
- search
48+
49+
# Customization
50+
extra:
51+
social:
52+
- icon: fontawesome/brands/github
53+
link: https://github.com/ibm
54+
- icon: fontawesome/brands/twitter
55+
link: https://twitter.com/ibmdeveloper
56+
- icon: fontawesome/brands/linkedin
57+
link: https://www.linkedin.com/company/ibm/
58+
- icon: fontawesome/brands/youtube
59+
link: https://www.youtube.com/user/developerworks
60+
- icon: fontawesome/brands/dev
61+
link: https://dev.to/ibmdeveloper
62+
63+
# Extensions
64+
markdown_extensions:
65+
- abbr
66+
- admonition
67+
- attr_list
68+
- def_list
69+
- footnotes
70+
- meta
71+
- toc:
72+
permalink: true
73+
- pymdownx.arithmatex:
74+
generic: true
75+
- pymdownx.betterem:
76+
smart_enable: all
77+
- pymdownx.caret
78+
- pymdownx.critic
79+
- pymdownx.details
80+
- pymdownx.emoji:
81+
emoji_index: !!python/name:materialx.emoji.twemoji
82+
emoji_generator: !!python/name:materialx.emoji.to_svg
83+
- pymdownx.highlight
84+
- pymdownx.inlinehilite
85+
- pymdownx.keys
86+
- pymdownx.mark
87+
- pymdownx.smartsymbols
88+
- pymdownx.snippets:
89+
check_paths: true
90+
- pymdownx.superfences:
91+
custom_fences:
92+
- name: mermaid
93+
class: mermaid
94+
format: !!python/name:pymdownx.superfences.fence_code_format
95+
- pymdownx.tabbed
96+
- pymdownx.tasklist:
97+
custom_checkbox: true
98+
- pymdownx.tilde
-425 KB
Binary file not shown.
-296 KB
Binary file not shown.
-108 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

workshop/Lab0/README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,34 @@
44

55
Run through the instructions listed [here](https://github.com/IBM/kube101/tree/master/workshop/Lab0)
66

7-
## 2. Cloud shell login.
7+
## 2. Cloud shell login
88

9-
## 3. Docker hub account.
9+
## 3. Docker hub account
1010

1111
Create a [dockerhub](https://hub.docker.com/) user and set the environment variable.
12-
```
12+
13+
```bash
1314
DOCKERUSER=<dockerhub useid>
1415
```
1516

1617
## 4. Set the cluster name
1718

18-
```
19+
```bash
1920
ibmcloud ks clusters
2021

2122
OK
2223
Name ID State Created Workers Location Version Resource Group Name Provider
2324
user001-workshop bseqlkkd0o1gdqg4jc10 normal 3 months ago 5 Dallas 4.3.38_1544_openshift default classic
2425

2526

26-
CLUSTERNAME=use001-workshop
27+
CLUSTERNAME=use001-workshop
2728
```
29+
2830
or
2931

30-
```
32+
```bash
3133
CLUSTERNAME=`ibmcloud ks clusters | grep Name -A 1 | awk '{print $1}' | grep -v Name`
3234

3335
echo $CLUSTERNAME
3436
user001-workshop
3537
```
36-
37-
38-
39-
40-

0 commit comments

Comments
 (0)