Skip to content

Commit d7e49b5

Browse files
binnestravierbrianinnesCloud UserJaimeMagiera
authored
Tooling update and subgroup menu change + misc fixes (okd-project#275)
* update (okd-project#5) * docs/index: Update Slack channel & mailing list links (okd-project#264) * docs/index: Remove "Review our Apache 2 license" The license is already mentionned elsewhere and not primarily relevant as a first step for new users to get started. * docs/index: Update Slack channel & mailing list links * add Charter (okd-project#265) * add link to ignore file to overcome 403 return code (okd-project#254) (okd-project#3) * ignore link to https://medium.com/@casonadams/edgerouter-x-adguardhome-b9d453f5725b as site returns 403 Signed-off-by: Brian Innes <[email protected]> Co-authored-by: Brian Innes <[email protected]> Co-authored-by: Brian Innes <[email protected]> * added Charter + mkdoc fixes Co-authored-by: Brian Innes <[email protected]> Co-authored-by: Brian Innes <[email protected]> * added meeting minutes * fixed location * fixed affilations * adding minutes to menu and re-arranging * cleaning up minutes * explicit link * updated mkdocs.yaml * exclude minutes from spell checking * replace dead link for Faros * Color accessibility tweaks (okd-project#271) * Test commit * Revert "Test commit" This reverts commit bc8bd34bbf5308c6533ee05a72d30746910e04ca. * Updating copyright * Style updates * More color adjustments * Padding tweaks on homepage * Linear gradient for sidebar navs * Admonition bg color update * Code typography color tweak Co-authored-by: Timothée Ravier <[email protected]> Co-authored-by: Brian Innes <[email protected]> Co-authored-by: Brian Innes <[email protected]> Co-authored-by: Cloud User <[email protected]> Co-authored-by: Jaime Magiera <[email protected]> Co-authored-by: Jaime Magiera <[email protected]> Co-authored-by: LuminousCoder <[email protected]> * fix typo * additional technical content * update tooling versions * Update requirements.txt reduce version as github runner doesn't appear to be up to date with available releases * Update main.yml switch to fedora container Co-authored-by: Timothée Ravier <[email protected]> Co-authored-by: Brian Innes <[email protected]> Co-authored-by: Brian Innes <[email protected]> Co-authored-by: Cloud User <[email protected]> Co-authored-by: Jaime Magiera <[email protected]> Co-authored-by: Jaime Magiera <[email protected]> Co-authored-by: LuminousCoder <[email protected]>
1 parent 50e6e42 commit d7e49b5

13 files changed

+635
-443
lines changed

.github/actions/Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM squidfunk/mkdocs-material:7.1.8
1+
FROM squidfunk/mkdocs-material:8.2.14
22

33
RUN apk add --no-cache --update nodejs npm
44

.github/actions/entrypoint.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
cd "${GITHUB_WORKSPACE}"
44

55
# Python Dependencies
6-
pip --no-cache-dir install git+https://github.com/linkchecker/linkchecker@v10.0.1#egg=linkchecker
6+
pip --no-cache-dir install git+https://github.com/linkchecker/linkchecker@v10.1.0#egg=linkchecker
77
# NodeJS Dependencies
88
npm ci
99

.github/workflows/main.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
build:
1313
runs-on: ubuntu-latest
1414
container:
15-
image: quay.io/centos/centos:stream8
15+
image: quay.io/fedora/fedora:35
1616

1717
steps:
1818
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it

docs/installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ oc adm release extract --tools quay.io/openshift/okd:4.5.0-0.okd-2020-07-14-1537
7474
!!!Note
7575
You need a 4.x version of `oc` to extract the installer and the latest client. You can initially use the [official Openshift client (mirror)](https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/linux/){: target=_blank}
7676

77-
There are full instructions in the [OKD documentation](https://docs.okd.io/latest/installing/installing-preparing.html){: target=_blank} for each supported platform, but the main steps for an IPU install are:
77+
There are full instructions in the [OKD documentation](https://docs.okd.io/latest/installing/installing-preparing.html){: target=_blank} for each supported platform, but the main steps for an IPI install are:
7878

7979
1. extract the downloaded tarballs and copy the binaries into your PATH.
8080
2. run the following from an empty directory:

docs/okd_tech_docs/index.md

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
<!--- cSpell:ignore pullspecs -->
44

5+
!!!Warning
6+
This section is under construction
7+
58
This section of the documentation is for developers that want to customize OKD.
69

710
The section will cover:

docs/okd_tech_docs/modifying_okd.md

+30-20
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
<!--- cSpell:ignore podman Dockerfiles toolset -->
44

5+
!!!Warning
6+
This section is under construction
7+
58
The source code for OKD is available on [github](https://github.com/openshift){target=_blank}. OKD is made up of many components bundled into a release. You can find the exact commit for each component included in a release using the `oc adm release info` command with the `--commit-urls` option, as outlined in the [overview](./index.md#okd-releases) section.
69

710
To make a change to OKD you need to:
@@ -27,38 +30,45 @@ and
2730
```
2831
FROM registry.ci.openshift.org/origin/4.10:base
2932
```
30-
Note that these may change as golang and release requirements change.
33+
34+
!!!Note
35+
To original and replacement image may change as golang version and release requirements change.
36+
37+
!!!Question
38+
Is there a way to find the correct base image for an OKD release?
3139

3240
The original images are unavailable to the public. There is an effort to update the Dockerfiles with publically available images.
3341

34-
Scenario:
42+
### Example Scenario:
3543

36-
- Modify console-operator to have a link to the community site **okd.io** instead of **docs.okd.io**
37-
- add to pre-existing cluster
38-
- build a custom release to include the modified console-operator, then install a new cluster will custom release
44+
- Modify console-operator to have a link to the community site **okd.io** instead of **docs.okd.io**
45+
- add to pre-existing cluster
46+
- build a custom release to include the modified console-operator, then install a new cluster will custom release
47+
48+
To complete the scenario the following steps need to be performed:
3949

4050
1. Fork the console-operator repository
4151
2. Clone the new fork locally: `git clone https://github.com/<username>/console-operator.git`
4252
3. create new branch from master (or main): `git switch -c <branch name>`
4353
4. Make needed modifications. Commit/squash as needed. Maintainers like to see 1 commit rather than several.
4454
5. Create the image: `podman build -f <Dockerfile file> -t <target repo>/<username>/console-operator:4.11-<some additional identifier>`
4555
6. Push image to external repository: `podman push <target repo>/<username>/console-operator:4.11-<some additional identifier>`
46-
7. Create new release to test with. This requires the `oc` command to be available. I use the following script. It can be modified as needed:
47-
```
48-
$ cat make_payload.sh
49-
server=https://api.ci.openshift.org
50-
51-
from_release=registry.ci.openshift.org/origin/release:4.11.0-0.okd-2022-04-12-000907
52-
release_name=4.11.0-0.jef-2022-04-12-0
53-
to_image=quay.io/fortinj66/origin-release:v4.11-console-operator
54-
55-
oc adm release new --from-release ${from_release} \
56-
--name ${release_name} \
57-
--to-image ${to_image} \
58-
console-operator=<target repo>/<username>/console-operator:4.11-<some additional identifier>
59-
```
56+
7. Create new release to test with. This requires the `oc` command to be available. I use the following script (make_payload.sh). It can be modified as needed, such as adding the correct container registry and username:
57+
58+
```shell
59+
server=https://api.ci.openshift.org
60+
61+
from_release=registry.ci.openshift.org/origin/release:4.11.0-0.okd-2022-04-12-000907
62+
release_name=4.11.0-0.jef-2022-04-12-0
63+
to_image=quay.io/fortinj66/origin-release:v4.11-console-operator
64+
65+
oc adm release new --from-release ${from_release} \
66+
--name ${release_name} \
67+
--to-image ${to_image} \
68+
console-operator=<target repo>/<username>/console-operator:4.11-<some additional identifier>
69+
```
6070

61-
`from_release`, `release_name`, `to_image` will need to be updated as needed
71+
`from_release`, `release_name`, `to_image` will need to be updated as needed
6272

6373
8. Pull installer for cluster release: `oc adm release extract --tools <to_image from above>` (Make sure image is publically available)
6474

docs/okd_tech_docs/operators.md

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
<!--- cSpell:ignore Devworkspace devspaces -->
44

5+
!!!Warning
6+
This section is under construction
7+
58
OKD contains many operators which deliver the base platform, however there is also additional capabilities delivered as operators available via the Operator Hub.
69

710
The operator hub story for OKD isn't ideal currently (as at OKD 4.10) as OKD shares source with OpenShift, the commercial sibling to OKD. OpenShift has additional operator hub catalogs provided by Red Hat, which deliver additional capabilities as part of the supported OpenShift product. These additional capabilities are not currently provided to OKD.

docs/okd_tech_docs/release.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# OKD Development Resources
22

3+
!!!Warning
4+
This section is under construction
5+
36
!!!Question
47
What is the end-to-end process to build an OKD release?
58
Is it possible outside Red Hat CI infrastructure?

docs/okd_tech_docs/troubleshoot.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Troubleshooting OKD
2+
3+
!!!Warning
4+
This section is under construction
5+
6+
!!!Todo
7+
Complete this section from comments in [discussion thread](https://github.com/openshift/okd/discussions/1198){target=_blank}

mkdocs.yml

+13-11
Original file line numberDiff line numberDiff line change
@@ -89,25 +89,27 @@ nav:
8989
- Code of Conduct: conduct.md
9090
- Contributor: contributor.md
9191
- OKD Working Groups:
92-
- OKD Working Group:
92+
- OKD Working Group:
9393
- About: working-groups.md
9494
- Charter: charter.md
9595
- Minutes: working-group/minutes/minutes.md
96-
- Documentation:
97-
- Overview: wg_docs/overview.md
98-
- Modifying OKD.io: wg_docs/okd-io.md
99-
- Setup environment: wg_docs/doc-env.md
100-
- Content guidelines: wg_docs/content.md
101-
- CRC Build:
102-
- Overview: wg_crc/overview.md
103-
- OKD Virtualization:
104-
- Overview: wg_virt/overview.md
105-
- Community: wg_virt/community.md
96+
- Subgroups:
97+
- Documentation:
98+
- Overview: wg_docs/overview.md
99+
- Modifying OKD.io: wg_docs/okd-io.md
100+
- Setup environment: wg_docs/doc-env.md
101+
- Content guidelines: wg_docs/content.md
102+
- CRC Build:
103+
- Overview: wg_crc/overview.md
104+
- OKD Virtualization:
105+
- Overview: wg_virt/overview.md
106+
- Community: wg_virt/community.md
106107
- OKD Development:
107108
- Overview: okd_tech_docs/index.md
108109
- Modifying OKD: okd_tech_docs/modifying_okd.md
109110
- Operator Hub catalogs: okd_tech_docs/operators.md
110111
- Release: okd_tech_docs/release.md
112+
- Troubleshooting: okd_tech_docs/troubleshoot.md
111113
- Help:
112114
- Getting Help: help.md
113115
- FAQ: faq.md

0 commit comments

Comments
 (0)