Skip to main content
Version: dev

Install options

The Kind installer

The script is scripts/kind/setup-rossoctl.sh. It always installs the core components. Each other component has an option.

The core components

cert-manager, the Gateway API resources, the Istio gateway controller, Keycloak, the operator and the webhook.

The component options

OptionWhat it addsWhat it also enables
--with-istioThe Istio ambient mesh: mTLS and waypoints
--with-spireSPIRE and the SPIFFE identity provider
--with-backendThe Rossoctl backend
--with-uiThe console--with-backend
--with-mcp-gatewayThe MCP Gateway
--with-kuadrantThe Kuadrant operator--with-mcp-gateway
--with-otelThe OpenTelemetry collector
--with-mlflowMLflow--with-otel, --with-istio
--with-buildsTekton and Shipwright
--with-kialiKiali and Prometheus--with-istio
--with-skillsThe skills flags and a skill store in the cluster--with-backend, --with-ui
--with-examplesThe weather agent and the weather tool
--with-allEach option above

The other options

OptionFunction
--skip-clusterUses a Kind cluster that exists.
--build-imagesBuilds the platform images from source and copies them into Kind.
--preload-imagesDownloads the third-party images first, then copies them into the node. This option avoids the rate limits of Docker Hub.
--secrets-file FILENames a file of secrets. The default is charts/rossoctl/.secrets.yaml, when that file exists.
--cluster-name NAMENames the Kind cluster. The default is rossoctl.
--domain DOMAINSets the domain for each address. The default is localtest.me.
--rossoctl-values FILEA Helm values file for the rossoctl chart.
--rossoctl-deps-values FILEA Helm values file for the rossoctl-deps chart.
--dry-runPrints each command. It makes no change.

The script gives the --rossoctl-values file to Helm as --values. Each valid Helm value is therefore accepted.

For the current list, run scripts/kind/setup-rossoctl.sh --help.

The OpenShift installer

The script is scripts/ocp/setup-rossoctl.sh.

OptionFunction
--rossoctl-repo PATH|URLA local directory or a GitHub address. The default action is a clone of main into ~/.cache/rossoctl.
--realm REALMThe Keycloak realm. The default is rossoctl.
--skip-ovn-patchOmits the OVN routing change.
--skip-mcp-gatewayOmits the MCP Gateway.
--skip-uiOmits the console and the backend.
--skip-mlflowOmits MLflow.
--operator-image IMG:TAGUses a different operator image.
--dry-runPrints each command. It makes no change.

Remove an installation

scripts/kind/cleanup-rossoctl.sh # Remove Rossoctl. Keep the cluster.
scripts/kind/cleanup-rossoctl.sh --destroy-cluster # Remove both.

The feature flags

Set each flag in the Helm values, during the installation or with the --reuse-values option.

FlagWhat it controls
featureFlags.skillsImport, list and delete a skill, and give a skill to an agent.
featureFlags.externalSkillsReferences to an external skill registry. It needs skills also.
components.skillberryStore.enabledInstalls the skill store in the cluster.
ui.backend.contextServiceUrlEnables agent context. An empty value disables it.
meshSelfHeal.enabledFor Kind only. Adds a CronJob that restarts the data plane after a certificate expires.

The rossoctl-feature-gates ConfigMap is separate. It applies to the whole cluster. It controls which RossoCortex components run, and whether skill discovery is active. A namespace cannot replace it, and a workload cannot replace it. See Custom resources.

The supported versions

The tools

ToolVersion
kubectl1.32.1 or later
Helm3.18.0 or later, below 4
git2.48.0 or later
Ollama0.11.0 or later, when you use it
oc4.16.0 or later, for OpenShift

The platforms

PlatformStatus
Kubernetes on KindThe primary target for development. The test pipeline uses version 1.35.0.
OpenShiftThe project tested version 4.19. The test pipeline uses version 4.20 with HyperShift.
Another Kubernetes distributionIt must operate with Helm. The test pipeline does not cover it.

For the state of each test pipeline, see the repository README.

The machine size

ProfileMemoryCPUsWhat operates
Recommended18 GiB6The ambient mesh, SPIRE, the console, the backend and a build from source.
Minimum16 GiB4The core platform and the console. Images only.
Below the minimum4 or fewerThe installation usually completes. A build stays in Pending.

The installer gives a warning below the recommended values. It does not stop.

The namespaces

NamespaceContents
rossoctl-systemThe operator, the webhook, the backend, the console and MLflow
keycloakKeycloak and its database
istio-systemThe Istio control plane, ztunnel and the gateways
spire-systemThe SPIRE agent
zero-trust-workload-identity-managerThe SPIRE DaemonSets
gateway-systemThe Envoy proxy of the MCP Gateway
mcp-systemThe controller, the broker and the router of the MCP Gateway
cr-systemThe container registry in the cluster
Your own namespacesYour agents and tools