Skip to content

Commit

Permalink
Merge pull request #208 from rackerlabs/fix-style
Browse files Browse the repository at this point in the history
docs: fix code block style
  • Loading branch information
cardoe authored Aug 12, 2024
2 parents 0384b72 + 0662267 commit 943f480
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 22 deletions.
10 changes: 10 additions & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,13 @@ MD033: true
# MD041 - First line in a file should be a top-level heading
# This requires a top-level heading as the first line in every doc.
MD041: true

# MD046 - Code blocks should be fenced for mkdocs
# unless you're using tabs which will require you to disable
# this check around that block like:
# <!-- markdownlint-capture -->
# <!-- markdownlint-disable MD046 -->
# all your tab stuff here
# <!-- markdownlint-restore -->
MD046:
style: fenced
9 changes: 9 additions & 0 deletions docs/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ UnderStack also uses common kubernetes tools: Helm, Kustomize, and Kubeseal.
[Helm](https://helm.sh) is a package manager for kubernetes and UnderStack uses a number of
upstream Helm charts.

<!-- markdownlint-capture -->
<!-- markdownlint-disable MD046 -->
!!! example "Installation"

=== "Ubuntu"
Expand All @@ -23,11 +25,14 @@ upstream Helm charts.
sudo apt-get update
sudo apt-get install helm
```
<!-- markdownlint-restore -->

### Kustomize

[Kustomize](https://kubectl.docs.kubernetes.io/guides/introduction/kustomize/) helps make customizations in kubernetes easier.

<!-- markdownlint-capture -->
<!-- markdownlint-disable MD046 -->
!!! example "Installation"

=== "Ubuntu"
Expand All @@ -36,12 +41,15 @@ upstream Helm charts.
curl -s "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh" | bash
sudo mv kustomize /usr/bin
```
<!-- markdownlint-restore -->

### Kubeseal

[Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets) and the `kubeseal` cli tool make it possible to
store sescrets in a public repository.

<!-- markdownlint-capture -->
<!-- markdownlint-disable MD046 -->
!!! example "Installation"

=== "Ubuntu"
Expand All @@ -51,3 +59,4 @@ store sescrets in a public repository.
tar xzf kubeseal-0.26.0-linux-amd64.tar.gz
sudo mv kubeseal /usr/bin
```
<!-- markdownlint-restore -->
47 changes: 25 additions & 22 deletions docs/user-guide/openstack-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The easiest way to install the OpenStack CLI is to utilize your
OS packages. But if you want to install it manually you will need
to already have Python on your system.

<!-- markdownlint-capture -->
<!-- markdownlint-disable MD046 -->
=== "Ubuntu or Debian"

``` bash
Expand Down Expand Up @@ -43,38 +45,39 @@ to already have Python on your system.
export PATH="$HOME/.bin:$PATH"
EOF
```
<!-- markdownlint-restore -->

## Configuration

The easiest way to configure your client is via `clouds.yaml`.

``` yaml title="$HOME/.config/openstack/clouds.yaml"
clouds:
understack:
auth:
auth_url: https://your.endpoint.url/v3
user_domain_name: mydomain
username: myuser
password: mypass
project_domain_name: mydomain
project_name: myproject
region_name:
- MyRegion
interface: public
identity_api_version: 3
```
```yaml title="$HOME/.config/openstack/clouds.yaml"
clouds:
understack:
auth:
auth_url: https://your.endpoint.url/v3
user_domain_name: mydomain
username: myuser
password: mypass
project_domain_name: mydomain
project_name: myproject
region_name:
- MyRegion
interface: public
identity_api_version: 3
```
With the above configuration in `$HOME/.config/openstack/clouds.yaml` you
will be able to run the OpenStack CLI as follows:

``` bash
openstack --os-cloud understack <sub-command-here>
```
```bash
openstack --os-cloud understack <sub-command-here>
```

Or you can set the `OS_CLOUD` environment variable once and shorten the
command as follows:

``` bash
export OS_CLOUD=understack
openstack <sub-command-here>
```
```bash
export OS_CLOUD=understack
openstack <sub-command-here>
```

0 comments on commit 943f480

Please sign in to comment.