Rio can be installed from both the CLI or a Kubernetes manifest.
- Download the latest release.
$ curl -sfL https://get.rio.io | sh - Note: by default the script will only download the latest release from GitHub. To test a pre-release or alpha build, run.
$ curl -sfL https://get.rio.io | INSTALL_RIO_VERSION=${version} sh - -
Prepare a Kubernetes cluster, see Clusters and Providers. Set the KUBECONFIG environment variable to point to your Kubernetes cluster.
-
Run
$ rio installNote: to install Rio with a Kubernetes manifest, run rio install --yaml. It will print out the Kubernetes manifest instead of
installing Rio directly, so that you can apply the manifest later.
See the CLI install reference docs for complete list of options.
To lower footprint of rio, use the disable-features flag. Just be aware that you are disabling features of Rio. Check here.
A 1.15 or higher version of Kubernetes is recommended.
See the Kubernetes getting started guide to help choose a cluster type.
Some cloud providers will use an internal IP address by default and Rio will use that for its cluster domain. You can override this during cluster setup by configuring external IP's, or by using a cloud-provider to setup a load balancer which will have an external IP.
For an example of installing a cluster with a cloud provider on Linode using Rancher, see step #8 on this doc.
When installing a K3s cluster, use the --no-deploy traefik flag if you would like Rio to provision load balancing for you. If you would like to keep this for ingresses, you can disable Gloo when installing rio.
Ensure you are running enough nodes with proper instance types to allow for the Rio and Kubernetes systems to run at least 45 pods. See the docs to help determine proper sizes:
- Guide: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI
- Total limits: https://github.com/awslabs/amazon-eks-ami/blob/master/files/eni-max-pods.txt
For example: you have a workload that requires 15 pods and you want to run 2 nodes. 15+45 is a 60 pod minimum requirement, so running 2 t3.large nodes (2*35=70) would be just enough.
Rio contains several independent components that are responsible for different functions, including service mesh, source code to deployment, autoscaling and advanced API gateway. By default it will install the bare minimum components to allow for the most basic rio functionality, including running services and canary deployments.
Autoscaling and Build features are not enabled by default during rio install, but are automatically enabled when a service is created that wants to use these, i.e rio run --scale 0-4 -p 8080 https://github.com/rancher/rio-demo.
Linkerd is not enabled by default on clusters with less than 3GB of memory. See Flipping features after installation to learn how to enable this and other features.
If you have limited capacities in your cluster and don't want enable some of features, you can disable features to make footprint of Rio smaller.
Here is the list of features:
| Feature | Description |
|---|---|
| autoscaling | Auto-scaling services based on in-flight requests |
| build | Rio Build, from source code to deployment |
| gloo | API gateway backed by gloo |
| linkerd | Linkerd service mesh |
| letsencrypt | Let's Encrypt |
| rdns | Acquire DNS from public Rancher DNS service |
| dashboard | Rio UI |
The core functionality of Rio includes Rio CLI UX and Riofile UX, which is built-in and doesn't rely on any of these features. Beside core functionality, here is a list of advanced features.
Manages autoscaling services in Rio. It deploys a pod inside cluster, watches the autoscaling config for each service, and scrapes metrics from pods. It will then make decisions to scale pods up and down based on those real-time metrics and autoscaling configs.
NOTE: The metrics are scraped from Linkerd, so if that feature is disabled, autoscaling will not work.
Build is responsible for building images from source code, which allows you to run deployment directly from source code with a Dockerfile. Build is also responsible for setting up webhook to watch your source code change and trigger automatic builds.
Gloo is the default API gateway Rio deploys to manage ingress traffic outside of cluster. It uses Envoy under the hood to provide rate limiting, circuit breaking, retries and other advanced routing features. Rio router programs Gloo virtualservices.
Linkerd is a service mesh for Kubernetes and other frameworks. It makes running services easier and safer by giving you runtime debugging, observability, reliability, and security—all without requiring any changes to your code. By default Rio ships with Linkerd and enables its service mesh within Rio services
Letsencrypt is default CA that Rio uses to provision and sign certificates and use that to provide TLS traffic for your workloads. You easily swap certificates to your own certs. Under the hood it deploys cert-manager to manage certificate provisioning.
Rdns is public DNS service hosted by Rancher. Each cluster with Rio installed will get a unique cluster domain (xxxxxx.on-rio.io). Rio registers this domain to Loadbalancer IP of API gateway service, which will eventually point to your service. Rdns will keep DNS record up-to-date if loadbalancer IP has changed. If you disabled this feature, you are responsible for updating your own DNS record if the loadbalancer IP changes.
Dashboard is a built-in web UI for Rio that runs within the cluster. It can be used as an alternative to the Rio CLI.
Note: If You have limited cpu and memory in your k8s cluster, we recommend you to disable features that you don't need in order to keep footprint of Rio smaller.
To disable linkerd service mesh:
$ rio install --disable-features linkerd If you would like to use your own cluster domain and certificates instead of rdns and letsencrypt, you can disable these two features:
$ rio install --disable-features rdns,letsencrypt And follow docs in here to see how to bring your own cluster domain and certs.
Rio manages features in a configMap called rio-config in rio-system namespace. It follows the format:
{
"features": {
"autoscaling": {
"enabled": true
},
"build": {
"enabled": true
},
"dashboard": {
"enabled": true
},
"linkerd": {
"enabled": true,
"options": {
"upgrade": "true"
}
},
"gloo": {
"enabled": true
},
"rdns": {
"enabled": true
}
},
"letsEncrypt": {
"email": "your@email.here"
},
"gateway": {
"serviceName": "gateway-proxy",
"serviceNamespace": "rio-system"
}
}To edit the configMap, run
rio system feature --edit