Skip to content

Commit 5f89488

Browse files
authored
feat: Carvel Package the easy way (#29)
* refactor: Easy vs Hard * docs: Update tabs * docs: Improve carvel tutorial * docs: mmmm, fresh tutorials * docs: This will do for now
1 parent da3dd3f commit 5f89488

40 files changed

+1555
-280
lines changed

.github/workflows/wrangler.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ jobs:
134134
if: |
135135
env.BRANCH_NAME_CURRENT != env.BRANCH_NAME_DEFAULT &&
136136
steps.hugo_build_staging.outcome == 'success'
137-
uses: cloudflare/[email protected].0
137+
uses: cloudflare/[email protected].1
138138
with:
139139
environment: staging
140140
apiToken: ${{ env.WRANGLER_API_TOKEN }}
@@ -148,7 +148,7 @@ jobs:
148148
if: |
149149
env.BRANCH_NAME_CURRENT == env.BRANCH_NAME_DEFAULT &&
150150
steps.hugo_build_production.outcome == 'success'
151-
uses: cloudflare/[email protected].0
151+
uses: cloudflare/[email protected].1
152152
with:
153153
environment: production
154154
apiToken: ${{ env.WRANGLER_API_TOKEN }}

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,4 +110,4 @@ It can get a little confusing, so here's a table to track the weights.
110110
| Search | 1 |
111111
| Frameworks | 1000-1999 |
112112
| Technologies | 2000-2999 |
113-
| Guides | 3000-3999 |
113+
| Tutorials | 3000-3999 |

content/changelog/_index.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,22 @@ draft: false
1414

1515
### January 2024
1616

17-
Fixed a bunch of broken links thanks to the only person who has ever contacted me about them being broken. Thanks! 👍
17+
Fixed broken links and added a new Carvel tutorial.
18+
19+
Special thanks to the person who contacted me about them being broken, at least someone is reading this! 👍 😄
1820

1921
{{< changelog "Fixed" >}}
2022

2123
- Fixed broken links.
2224

2325
{{</ changelog >}}
2426

27+
{{< changelog "Added" >}}
28+
29+
- Added a Carvel package tutorial the "easy way"
30+
31+
{{</ changelog >}}
32+
2533
### November 2023
2634

2735
Added an awesome Carvel YouTube video from Thomas Vitale.

content/technologies/harbor/rotate_certs.md

+5
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,17 @@ Harbor certificate rotation steps.
1717
- Stop the Harbor service
1818

1919
```bash
20+
# Stop the systemd unit.
2021
sudo systemctl stop harbor
2122
```
2223

2324
- Backup the existing certificates
2425

2526
```bash
27+
# Create a directory
2628
sudo mkdir -p ${HOME}/backup/$(date +%Y%m%d)
2729

30+
# Copy the files
2831
sudo cp /storage/data/secret/cert/server.crt ${HOME}/backup/$(date +%Y%m%d)/server.crt
2932
sudo cp /storage/data/secret/cert/server.key ${HOME}/backup/$(date +%Y%m%d)/server.key
3033
sudo cp /storage/data/secret/cert/ca.crt ${HOME}/backup/$(date +%Y%m%d)/ca.crt
@@ -36,6 +39,7 @@ sudo cp /storage/data/secret/cert/ca.crt ${HOME}/backup/$(date +%Y%m%d)/ca.crt
3639
# Place the new certificates in the ${HOME}/certs directory
3740
sudo mkdir -p "${HOME}/certs"
3841

42+
# Copy the files
3943
sudo cp "${HOME}/certs/server.crt" /storage/data/secret/cert/server.crt
4044
sudo cp "${HOME}/certs/server.key" /storage/data/secret/cert/server.key
4145
sudo cp "${HOME}/certs/ca.crt" /storage/data/secret/cert/ca.crt
@@ -44,5 +48,6 @@ sudo cp "${HOME}/certs/ca.crt" /storage/data/secret/cert/ca.crt
4448
- Start the Harbor service
4549

4650
```bash
51+
# Start the system unit
4752
sudo systemctl start harbor
4853
```

content/technologies/salt-project/_index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ One example is `test.ping` which returns `True` if the Salt Minion is responding
5656
Example usage
5757

5858
```bash
59+
# Check which hosts are alive.
5960
salt '*' test.ping
6061
```
6162

@@ -67,7 +68,8 @@ Salt Runners, invoked from `salt-run` are similar to Salt Execution modules exce
6768

6869
Salt States describe the desired state of a specific part of a targeted system. For example the following state ensure that a file is present on the system
6970

70-
```bash
71+
```yaml
72+
# Example
7173
Ensure hosts file present:
7274
file.present:
7375
- name: /etc/hosts

content/tutorials/carvel/_index.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ date: 2021-01-20T15:00:00+10:00
44
icon: "fas fa-tools"
55
description: "Carvel tutorials and training material."
66
type: "docs"
7-
weight: 3203
7+
weight: 3300
88
draft: false
99
---
1010

@@ -16,15 +16,15 @@ _Carvel_, formally known as _k14s_, is a Kubernetes toolchain comprised of indiv
1616

1717
Information and tutorial on the toolchain components.
1818

19-
| Link | Description |
20-
| ---------------------------------- | ---------------------------------------- |
21-
| [vendir](vendir) | Getting started with `vendir` |
22-
| [ytt](ytt) | Getting started with `ytt` |
23-
| [kbld](kbld) | Getting started with `kbld` |
24-
| [imgpkg](imgpkg) | Getting started with `imgpkg` |
25-
| [kapp](kapp) | Getting started with `kapp` |
26-
| [kapp-controller](kapp-controller) | Getting started with `kapp-controller` |
27-
| [tutorial](tutorial) | Create a Carvel Package _"the hard way"_ |
19+
| Link | Description |
20+
| ---------------------------------- | -------------------------------------- |
21+
| [vendir](vendir) | Getting started with `vendir` |
22+
| [ytt](ytt) | Getting started with `ytt` |
23+
| [kbld](kbld) | Getting started with `kbld` |
24+
| [imgpkg](imgpkg) | Getting started with `imgpkg` |
25+
| [kapp](kapp) | Getting started with `kapp` |
26+
| [kapp-controller](kapp-controller) | Getting started with `kapp-controller` |
27+
| [packages](packages) | Working with Carvel Packages |
2828

2929
## Resources
3030

File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: "Packages"
3+
date: 2021-03-01T00:00:00+00:00
4+
icon: "fa-solid fa-box"
5+
description: "Working with Carvel packages"
6+
type: "docs"
7+
weight: 3308
8+
draft: false
9+
---
10+
11+
## Overview
12+
13+
Once you know about the individual tools, it's time to look at how to combine them.
14+
15+
The carvel toolchain has a clear separation between the `Package Author` and `Package Consumer` personas.
16+
17+
- `Package Authors` create and publish Carvel packages.
18+
- `Package Consumers` deploy and update Carvel packages is running clusters.
19+
20+
Depending on your team size and responsibilities you might wear both hats 🤠
21+
22+
### Package Author
23+
24+
Tutorials for the Carvel `Package Author`.
25+
26+
| Name | Description |
27+
| :-------------------------: | :---------------------------------------------------------------- |
28+
| [The hard way](author/hard) | Learn how the sausage is made building a Carvel package manually. |
29+
| [The easy way](author/easy) | Take the easy way out with the awesome `kctrl` utility. |
30+
31+
### Package Consumer
32+
33+
Tutorials for the Carvel `Package Consumer`.
34+
35+
| Name | Description |
36+
| :---------------------------: | :-------------------------------------- |
37+
| [The easy way](consumer/easy) | The consumer only has the _easy_ way 😄 |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "Package Author"
3+
date: 2024-01-01T00:00:00+00:00
4+
icon: "fa-solid fa-box"
5+
description: "Package Author"
6+
type: "docs"
7+
weight: 3400
8+
draft: false
9+
---
10+
11+
## Overview
12+
13+
In this section you will play the part of the `Package Author` persona.
14+
15+
## Tutorials
16+
17+
A choose your own adventure story.
18+
19+
| Name | Description |
20+
| :------------------: | :------------------------------------------------------- |
21+
| [The hard way](hard) | Learn how the sausage is made building a Carvel package. |
22+
| [The easy way](easy) | Take the easy way out with the awesome `kctrl` utility. |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "Easy"
3+
date: 2024-01:01T00:00:00+00:00
4+
icon: "fa-solid fa-box"
5+
description: "Create a Carvel package the easy way"
6+
type: "docs"
7+
weight: 3600
8+
draft: false
9+
---
10+
11+
## Overview
12+
13+
This tutorial authors a Carvel package using the `kctrl` CLI which interfaces with the [kapp-controller](https://github.com/carvel-dev/kapp-controller).
14+
15+
**NOTE:** There is also a tutorial in the official documentation [here](https://carvel.dev/kapp-controller/docs/latest/kctrl-package-authoring)
16+
17+
## Steps
18+
19+
1. [Prepare](prepare)
20+
2. [Run kctrl](kctrl)

0 commit comments

Comments
 (0)