Skip to content

Commit 5825091

Browse files
authored
Merge pull request #39 from cgwalters/docs
docs: Start adding some
2 parents 45b3dc0 + a9325a4 commit 5825091

File tree

3 files changed

+58
-1
lines changed

3 files changed

+58
-1
lines changed

.github/workflows/docs.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v3
23+
- name: Setup Pages
24+
uses: actions/configure-pages@v3
25+
- name: Build with Jekyll
26+
uses: actions/jekyll-build-pages@v1
27+
with:
28+
source: ./docs
29+
destination: ./_site
30+
- name: Upload artifact
31+
uses: actions/upload-pages-artifact@v1
32+
33+
# Deployment job
34+
deploy:
35+
environment:
36+
name: github-pages
37+
url: ${{ steps.deployment.outputs.page_url }}
38+
runs-on: ubuntu-latest
39+
needs: build
40+
steps:
41+
- name: Deploy to GitHub Pages
42+
id: deployment
43+
uses: actions/deploy-pages@v1

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The `bootc install` command will write the current container to a disk, and set
8181
For example, booting a Fedora-derivative (including CentOS and RHEL) system, whether a cloud guest or a live ISO, you can invoke:
8282

8383
```
84-
$ podman run --privileged --pid=host --net=none --security-opt label=type:unconfined_t --target-no-signature-verification ghcr.io/cgwalters/c9s-oscore bootc install /path/to/disk
84+
$ podman run --privileged --pid=host --net=none --security-opt label=type:unconfined_t ghcr.io/cgwalters/c9s-oscore bootc install --target-no-signature-verification /path/to/disk
8585
```
8686

8787
As noted above though, if you create a *derivative* container image, it also automatically supports `bootc install`.

docs/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
nav_order: 1
3+
---
4+
5+
# Rationale
6+
7+
The bootc project starts from a basic premise: Docker/OCI style containers
8+
are successful, what if we supported putting a Linux kernel binary inside
9+
one too, and created client tooling (like `docker`/`podman`) that understood
10+
how to use container images for in-place transactional (default stateful)
11+
operating system upgrades.
12+
13+
With `bootc`, bootable operating systems can be created and deployed using all the same
14+
familiar tools and techniques one uses for *application* container images.

0 commit comments

Comments
 (0)