Merge pull request #49 from okd-project/wg-statement-scos-base-migration

Working Group statement on build delays and migrating cluster components to SCOS base

.github/actions/entrypoint.sh

@@ -3,7 +3,7 @@
 cd "${GITHUB_WORKSPACE}"
 
 # Python Dependencies
-pip --no-cache-dir install git+https://github.com/linkchecker/linkchecker@v10.1.0#egg=linkchecker
+pip --no-cache-dir install git+https://github.com/linkchecker/linkchecker@v10.3.0#egg=linkchecker
 # NodeJS Dependencies
 npm ci
 

.github/workflows/check-build.yml

@@ -0,0 +1,34 @@
+name: Build Check
+
+on:
+  pull_request:
+    branches: [ main ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  TITLE: OKD.io
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+      - name: Install dependencies (Python)
+        run: pip install -r requirements.txt --break-system-packages
+      - name: Install dependencies (Node)
+        run: npm ci
+      - name: Spellcheck
+        run: ./node_modules/.bin/cspell "docs/**/*.md"
+      - name: Build the site
+        run: mkdocs build --strict --clean --verbose
+      - name: Upload built site
+        uses: actions/upload-artifact@v4
+        with:
+          name: okd.io
+          path: public/
+          if-no-files-found: error
+      - name: Log any discovered broken links
+        run: linkchecker -f linkcheckerrc public || true

.github/workflows/publish.yaml

@@ -3,23 +3,30 @@ name: Publish
 on:
   push:
     branches: [ main ]
+  workflow_dispatch:
 
-jobs:
-  publish:
-
-    runs-on: ubuntu-latest
-
-    env:
-      NODE_VERSION: 12.x
-      TITLE: OKD.io
+env:
+  TITLE: OKD.io
 
+jobs:
+  build:
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v2
-      - name: generate site
-        uses: ./.github/actions/
-
-      - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+      - name: Install dependencies (Python)
+        run: pip install -r requirements.txt --break-system-packages
+      - name: Install dependencies (Node)
+        run: npm ci
+      - name: Spellcheck
+        run: ./node_modules/.bin/cspell "docs/**/*.md"
+      - name: Build the site
+        run: mkdocs gh-deploy --strict --clean --verbose -d public
+      - name: Upload built site
+        uses: actions/upload-artifact@v4
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./public
+          name: okd.io
+          path: public/
+          if-no-files-found: error
+      - name: Log any discovered broken links
+        run: linkchecker -f linkcheckerrc public || true

docs/blog/posts/okd-future-statement.md

@@ -0,0 +1,26 @@
+---
+draft: false 
+date: 2024-06-01
+---
+
+<!-- cSpell:ignore SCOS ostree homelabs -->
+
+# OKD Working Group Statement June 1, 2024
+
+We would like to take a moment to outline what's been happening the past few months in terms of OKD releases and what the future holds for the project. 
+
+In Summer of 2023, it came to the attention of Red Hat that licensed content was inadvertently being included in the OKD releases. This necessitates a change of the OKD release materials. At the same time, the Working Group has been striving to increase the community's direct involvement in the build and release process. To address these concerns, Red Hat and the Working Group have been collaborating on defining a path forward over the past few months. This work involves moving OKD builds to a new system, changing the underlying OS, and exposing the new build and release process to community members. 
+
+After careful consideration, we've settled on using Centos Stream CoreOS (SCOS) as the underlying operating system for the new builds. We've been working with SCOS since it was first announced at KubeCon U.S. 2022. There's a great opportunity with SCOS for the larger Open Source community to participate in improving OKD and further delineating it from other Kubernetes distributions. The builds will be for x86_64 only while we get our bearings. Given rpm-ostree is the foundation of all modern OKD releases, many existing installations will be able to switch to the SCOS distribution in-place. We're working to outline that procedure in our documentation and identify any edge-cases that may require more work to transition.
+
+The payload for OKD on SCOS is now successfully building. There are still end-to-end tests which need to complete successfully and other housekeeping tasks before pre-release nightly builds can spin up an active cluster. We anticipate this happening within the next few weeks. At that point, members of the community will be able to download these nightly builds for testing and exploration purposes.
+
+On the community involvement and engagement side of things, we'll be relaunching our website to align with the first official release of OKD on SCOS. That site will feature much clearer paths to the information users want to get their clusters up and running. We're redoubling our efforts to help homelabs, single-node, and other similar use cases get off the ground. Likewise, the new website will provide much clearer information on how community members can contribute to the project. 
+
+We appreciate everyone's patience over the past few months while we solidified the path forward. We wanted to be confident the pieces would fit together and bring about the desired results before releasing an official statement. From here on out, there will be regular updates on our website.
+
+We understand that there will be lots of questions as this process moves forward. Please post those questions on [this discussion thread](https://github.com/okd-project/okd/discussions/1922). We will organize them into this [Frequently Asked Questions page](https://okd.io/scos-migration-faq/).
+
+Many thanks,
+
+The OKD Working Group Co-Chairs

docs/scos-migration-faq.md

@@ -1,5 +1,7 @@
 # FAQ - OKD Components based on SCOS
 
+<!--cSpell:ignore SCOS -->
+
 This FAQ document relates to the builds of OKD that use CentOS Stream CoreOS (SCOS) after work done to stop using RHEL as the base for cluster components, as well as the upgrade path from pre-4.16 OKD FCOS/SCOS installations.
 
 *Holding Page*

mkdocs.yml

@@ -1,7 +1,7 @@
 site_name: OKD.io
 site_description: >-
   The Community Distribution of Kubernetes that powers Red Hat OpenShift
-site_url: https://openshift-cs.github.io/okd.io/index.html
+site_url: https://okd.io/
 site_author: Brian Innes
 repo_name: "okd-io"
 repo_url: https://github.com/okd-project/okd.io
@@ -159,3 +159,4 @@ nav:
   - Help:
       - Getting Help: help.md
       - FAQ: faq.md
+      - SCOS Migration FAQ: scos-migration-faq.md

requirements.txt

@@ -2,4 +2,6 @@
 mkdocs==1.6.0
 mkdocs-material==9.5.25
 mkdocs-minify-plugin==0.8.0
-git+https://github.com/linkchecker/linkchecker@v10.3.0#egg=linkchecker
+linkchecker==10.4.0
+pymdown-extensions==10.8.1
+mkdocs-material[imaging]==9.5.25