Skip to content

Commit

Permalink
Update FAQ, README and guides with new RC url
Browse files Browse the repository at this point in the history
  • Loading branch information
vrutkovs committed Jun 9, 2021
1 parent bf5799f commit 04d1035
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 16 deletions.
42 changes: 31 additions & 11 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,40 @@ Frequently Asked Questions
Below are answers to common questions regarding OKD installation and administration. If you have a suggested question or a suggested improvement to an answer, please feel free to reach out.

# General #
- [What are the relations with OCP project? Is OKD4 an upstream of OCP?](#what-are-the-relations-with-ocp-project-is-okd4-an-upstream-of-ocp)
- [How stable is OKD4?](#how-stable-is-okd4)
- [Can I run a single node cluster?](#can-i-run-a-single-node-cluster)
- [What to do in case of errors?](#what-to-do-in-case-of-errors)
- [Where do I seek support?](#where-do-i-seek-support)
- [Frequently Asked Questions](#frequently-asked-questions)
- [General](#general)
- [Upgrades](#upgrades)
- [Misc](#misc)
- [What are the relations with OCP project? Is OKD4 an upstream of OCP?](#what-are-the-relations-with-ocp-project-is-okd4-an-upstream-of-ocp)
- [How stable is OKD4?](#how-stable-is-okd4)
- [Can I run a single node cluster?](#can-i-run-a-single-node-cluster)
- [What to do in case of errors?](#what-to-do-in-case-of-errors)
- [Where do I seek support?](#where-do-i-seek-support)
- [Where can I find upgrades?](#where-can-i-find-upgrades)
- [How can I upgrade my cluster to a new version?](#how-can-i-upgrade-my-cluster-to-a-new-version)
- [Interesting commands while an upgrade runs](#interesting-commands-while-an-upgrade-runs)
- [How can I find out what's inside of a (CI) release and which commit id each component has?](#how-can-i-find-out-whats-inside-of-a-ci-release-and-which-commit-id-each-component-has)
- [How to use the official installation container?](#how-to-use-the-official-installation-container)

# Upgrades #
- [Where can I find upgrades?](#where-can-i-find-upgrades)
- [How can I upgrade my cluster to a new version?](#how-can-i-upgrade-my-cluster-to-a-new-version)

# Misc #
- [Interesting commands while an upgrade runs](#interesting-commands-while-an-upgrade-runs)
- [How can I find out what's inside of a (CI) release and which commit id each component has?](#how-can-i-find-out-whats-inside-of-a-ci-release-and-which-commit-id-each-component-has)
- [How to use the official installation container?](#how-to-use-the-official-installation-container)
- [Frequently Asked Questions](#frequently-asked-questions)
- [General](#general)
- [Upgrades](#upgrades)
- [Misc](#misc)
- [What are the relations with OCP project? Is OKD4 an upstream of OCP?](#what-are-the-relations-with-ocp-project-is-okd4-an-upstream-of-ocp)
- [How stable is OKD4?](#how-stable-is-okd4)
- [Can I run a single node cluster?](#can-i-run-a-single-node-cluster)
- [What to do in case of errors?](#what-to-do-in-case-of-errors)
- [Where do I seek support?](#where-do-i-seek-support)
- [Where can I find upgrades?](#where-can-i-find-upgrades)
- [How can I upgrade my cluster to a new version?](#how-can-i-upgrade-my-cluster-to-a-new-version)
- [Interesting commands while an upgrade runs](#interesting-commands-while-an-upgrade-runs)
- [How can I find out what's inside of a (CI) release and which commit id each component has?](#how-can-i-find-out-whats-inside-of-a-ci-release-and-which-commit-id-each-component-has)
- [How to use the official installation container?](#how-to-use-the-official-installation-container)

## What are the relations with OCP project? Is OKD4 an upstream of OCP?

Expand All @@ -32,7 +52,7 @@ These relationships are more complex than "upstream/downstream", so we use "sibl

## How stable is OKD4?

OKD4 builds are being automatically tested by [release-controller](https://origin-release.svc.ci.openshift.org/). Release is rejected if either installation, upgrade from previous version or conformance test fails. Test results determine the upgrade graph, so for instance, if upgrade tests passed for beta5->rc edge, clusters on beta5 can be directly updated to rc release, bypassing beta6.
OKD4 builds are being automatically tested by [release-controller](https://amd64.origin.releases.ci.openshift.org/). Release is rejected if either installation, upgrade from previous version or conformance test fails. Test results determine the upgrade graph, so for instance, if upgrade tests passed for beta5->rc edge, clusters on beta5 can be directly updated to rc release, bypassing beta6.

The OKD stable version is released bi-weekly, following Fedora CoreOS schedule, client tools are uploaded to Github and images are mirrored to Quay.

Expand Down Expand Up @@ -81,7 +101,7 @@ Contact us on Slack:
See https://openshift.tips/ for useful Openshift tips

## Where can I find upgrades?
https://origin-release.svc.ci.openshift.org/
https://amd64.origin.releases.ci.openshift.org/

Note that nightly builds (from `4.x.0-0.okd`) are pruned every 72 hours.
If your cluster uses these images, consider [mirroring](https://docs.okd.io/latest/installing/install_config/installing-restricted-networks-preparations.html#installing-restricted-networks-preparations) these files to a local registry.
Expand All @@ -90,7 +110,7 @@ Builds from the `stable-4` stream are not removed.
## How can I upgrade my cluster to a new version?
Find a version where a tested upgrade path is available from your version for on

https://origin-release.svc.ci.openshift.org
https://amd64.origin.releases.ci.openshift.org/

Upgrade options:

Expand Down
2 changes: 1 addition & 1 deletion Guides/IPI/azure/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This guide describes a workaround to get OKD 4 installed on Azure. It will not b
- You have access to an [Azure Cloud Shell](https://docs.microsoft.com/en-us/azure/cloud-shell/overview). This guide assumes that you chose Linux for your Cloud Shell.
- You have created a [Service Principle for OKD 4 in Azure](https://docs.openshift.com/container-platform/4.4/installing/installing_azure/installing-azure-account.html)
- You downloaded the openshift-installer and oc for the OKD version you're installing in your PATH. See [Getting Started](/README.md#getting-started)
- The openshift-installer should be either from [Beta5](https://origin-release.svc.ci.openshift.org/) or higher or a nightly build newer than 2020-05-11
- The openshift-installer should be either from [Beta5](https://amd64.origin.releases.ci.openshift.org/) or higher or a nightly build newer than 2020-05-11

## Procedure

Expand Down
2 changes: 1 addition & 1 deletion Guides/UPI/okd4-terraform-openstack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ may not be available on quay.io.
Ref:

* https://builds.coreos.fedoraproject.org/browser
* https://origin-release.svc.ci.openshift.org/
* https://amd64.origin.releases.ci.openshift.org/

## Configuring the deployment

Expand Down
2 changes: 1 addition & 1 deletion Guides/UPI/vSphere_terraform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ backend machine-config-server

Download oc from <https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/linux/>

Choose a release ([dev-releases](https://origin-release.svc.ci.openshift.org/), ...)
Choose a release ([dev-releases](https://amd64.origin.releases.ci.openshift.org/), ...)

Extract `openshift-install` tool (e.g. `oc adm release extract --command=openshift-install registry.ci.openshift.org/origin/release:4.4.0-0.okd-2020-02-28-084836`)

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The [OKD Working Group](https://github.com/openshift/community#okd-working-group
Getting Started
---------------

To obtain the openshift installer and client, visit [/releases](https://github.com/openshift/okd/releases) for stable versions or [https://origin-release.svc.ci.openshift.org/](https://origin-release.svc.ci.openshift.org/) for nightlies. See [a list of public keys](https://okd.io/keys.html) to verify tools signature. Please note that each nightly release is pruned after 72 hours. If the nightly that you installed was pruned, the cluster may be unable to pull necessary images and may show errors for various functionality (including updates).
To obtain the openshift installer and client, visit [/releases](https://github.com/openshift/okd/releases) for stable versions or [https://amd64.origin.releases.ci.openshift.org/](https://amd64.origin.releases.ci.openshift.org/) for nightlies. See [a list of public keys](https://okd.io/keys.html) to verify tools signature. Please note that each nightly release is pruned after 72 hours. If the nightly that you installed was pruned, the cluster may be unable to pull necessary images and may show errors for various functionality (including updates).
Alternatively, if you have the openshift client `oc` already installed, you can use it to download and extract the openshift installer and client from our container image:

```
Expand Down Expand Up @@ -130,7 +130,7 @@ OKD is built from many different open source projects - Fedora CoreOS, the CentO

Community process and questions can be raised in our [community repo](https://github.com/openshift/community) and issues [opened in this repository](https://github.com/openshift/okd/issues) (Bugzilla locations coming soon).

Our unified continuous integration system tests pull requests to the ecosystem and core images, then builds and promotes them after merge. To see the latest development releases of OKD visit [our continuous release page](https://origin-release.svc.ci.openshift.org). These releases are built continuously and expire after a few days. Long lived versions are pinned and then listed on our [stable release page](https://github.com/openshift/okd/releases).
Our unified continuous integration system tests pull requests to the ecosystem and core images, then builds and promotes them after merge. To see the latest development releases of OKD visit [our continuous release page](https://amd64.origin.releases.ci.openshift.org/). These releases are built continuously and expire after a few days. Long lived versions are pinned and then listed on our [stable release page](https://github.com/openshift/okd/releases).

All contributions are welcome - OKD uses the Apache 2 license and does not require any contributor agreement to submit patches. Please open issues for any bugs or problems you encounter, ask questions on the OpenShift IRC channel (#openshift-dev on freenode), or get involved in the [Kubernetes project](https://github.com/kubernetes/kubernetes) at the container runtime layer.

Expand Down

0 comments on commit 04d1035

Please sign in to comment.