Skip to content

docs: add OS_CLUSTER_VERSION to env.example and align dev docs #4670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tuxerrante wants to merge 4 commits into
base: master
Choose a base branch
from
+18 −14
Open

docs: add OS_CLUSTER_VERSION to env.example and align dev docs #4670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
36a9d4c
docs: add OS_CLUSTER_VERSION to env.example and align dev docs
tuxerrante Mar 10, 2026
e5664c4
fix: set Default field when inserting version into CosmosDB
tuxerrante Mar 11, 2026
52a3e19
docs: comment out OS_CLUSTER_VERSION in env.example and fix const com…
tuxerrante Mar 11, 2026
96d70c1
typo
tuxerrante Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions docs/deploy-development-rp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,37 +508,39 @@ export RESOURCEGROUP=<resource-group-name>
This command adds the image to your cosmosDB. **openShiftPullspec** comes from [quay.io/repository/openshift-release-dev](https://quay.io/repository/openshift-release-dev/ocp-release?tab=tags) (in production we must use sha tag, but in dev we can use tag for simplicity) ; and **installerPullspec** from int to work in dev without having to set any secret, but you can use repo for installer if you configured secret for it.

```bash
OCP_VERSION=<x.y.z>
OS_CLUSTER_VERSION="${OS_CLUSTER_VERSION:-<x.y.z>}"
curl -X PUT -k "https://localhost:8443/admin/versions" --header "Content-Type: application/json" -d '
{
"name": "'${OCP_VERSION}'",
"name": "'${OS_CLUSTER_VERSION}'",
"type": "Microsoft.RedHatOpenShift/OpenShiftVersion",
"properties":
{
"version": "'${OCP_VERSION}'",
"version": "'${OS_CLUSTER_VERSION}'",
"enabled": true,
"openShiftPullspec": "quay.io/openshift-release-dev/ocp-release:'${OCP_VERSION}'-x86_64",
"installerPullspec": "arointsvc.azurecr.io/aro-installer:release-'${OCP_VERSION%.*}'"
"default": true,
"openShiftPullspec": "quay.io/openshift-release-dev/ocp-release:'${OS_CLUSTER_VERSION}'-x86_64",
"installerPullspec": "arointsvc.azurecr.io/aro-installer:release-'${OS_CLUSTER_VERSION%.*}'"
}
}
'
```

If you want to run the installer version via hive and not in container, you will need to use sha instead of tag for OCP image, and you can use your docker connection for this:
```bash
docker login quay.io 16:36:10
OCP_VERSION=<x.y.z>
docker pull quay.io/openshift-release-dev/ocp-release:${OCP_VERSION}-x86_64
docker login quay.io
OS_CLUSTER_VERSION="${OS_CLUSTER_VERSION:-<x.y.z>}"
docker pull quay.io/openshift-release-dev/ocp-release:${OS_CLUSTER_VERSION}-x86_64
curl -X PUT -k "https://localhost:8443/admin/versions" --header "Content-Type: application/json" -d '
{
"name": "'${OCP_VERSION}'",
"name": "'${OS_CLUSTER_VERSION}'",
"type": "Microsoft.RedHatOpenShift/OpenShiftVersion",
"properties":
{
"version": "'${OCP_VERSION}'",
"version": "'${OS_CLUSTER_VERSION}'",
"enabled": true,
"openShiftPullspec": "'$(docker inspect --format='{{index .RepoDigests 0}}' quay.io/openshift-release-dev/ocp-release:${OCP_VERSION}-x86_64)'",
"installerPullspec": "arointsvc.azurecr.io/aro-installer:release-'${OCP_VERSION%.*}'"
"default": true,
"openShiftPullspec": "'$(docker inspect --format='{{index .RepoDigests 0}}' quay.io/openshift-release-dev/ocp-release:${OS_CLUSTER_VERSION}-x86_64)'",
"installerPullspec": "arointsvc.azurecr.io/aro-installer:release-'${OS_CLUSTER_VERSION%.*}'"
}
}
'
Expand Down
3 changes: 2 additions & 1 deletion env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ export AZURE_EXTENSION_DEV_SOURCES="$(pwd)/python"
export CLUSTER_RESOURCEGROUP="${AZURE_PREFIX}-v4-$LOCATION"
export CLUSTER_NAME="${AZURE_PREFIX}-aro-cluster"
export CLUSTER_VNET="${AZURE_PREFIX}-aro-vnet"
export ARO_IMAGE=arointsvc.azurecr.io/aro:latest
export ARO_IMAGE=arointsvc.azurecr.io/aro:latest
export ARO_ENABLE_OUTBOUND_HTTP_LOGGING=false
# export OS_CLUSTER_VERSION="${OS_CLUSTER_VERSION:-4.19.15}"
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OS_CLUSTER_VERSION is commented out, so sourcing env.example will not actually set a default cluster version. If the goal is for local dev tooling to pick up OS_CLUSTER_VERSION automatically, this should be an active export OS_CLUSTER_VERSION="${OS_CLUSTER_VERSION:-4.19.15}" (or otherwise document that users must uncomment it).

Copilot uses AI. Check for mistakes.

# You'll need these to create MIWI clusters with your local RP, but you can comment them
# out or remove them from your env file if you're only going to be creating service principal
Expand Down
1 change: 1 addition & 0 deletions pkg/util/cluster/cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1146,6 +1146,7 @@ func (c *Cluster) ensureDefaultVersionInCosmosdb(ctx context.Context) error {
// if it is not overridden with ARO_HIVE_DEFAULT_INSTALLER_PULLSPEC or LiveConfig
InstallerPullspec: fmt.Sprintf("arointsvc.azurecr.io/aro-installer:release-%s", version.DefaultInstallStream.Version.MinorVersion()),
Enabled: true,
Default: true,
},
Comment on lines 1147 to 1150
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Setting Default: true unconditionally can create multiple "default" OpenShift versions in CosmosDB if one already exists. The frontend cache logic treats this as a warning and will effectively pick whichever default is seen last, which can make "default version" selection non-deterministic. Consider checking whether any existing version is already marked default and only setting Default: true when no default exists (or explicitly clearing the previous default before creating a new one).

Copilot uses AI. Check for mistakes.
})
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion pkg/util/version/const.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ type Stream struct {
PullSpec string `json:"-"`
}

// Install stream data for production and INT has moved to RP-Config.
// DefaultInstallStream does not wrap data for production and INT which has moved to RP-Config.
// This default is left here ONLY for use by local development mode,
// until we can come up with a better solution.
Comment on lines +41 to 43
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updated comment reads awkwardly and seems to invert the intended meaning ("does not wrap data"). This looks like it should explain that production/INT install stream data moved to RP-Config and this constant is only a local-dev fallback; please reword for clarity to avoid misleading future readers.

Suggested change
// DefaultInstallStream does not wrap data for production and INT which has moved to RP-Config.
// This default is left here ONLY for use by local development mode,
// until we can come up with a better solution.
// DefaultInstallStream is NOT used for production or INT; install stream data for those
// environments is configured via RP-Config. This constant is kept only as a fallback for
// local development mode until we can come up with a better solution.

Copilot uses AI. Check for mistakes.
var DefaultInstallStream = Stream{
Expand Down
Loading