KubeSlice Controller Parameters

This topic describes the configuration parameters required to install the KubeSlice Controller and KubeSlice Manager, and create a project namespace.

KubeSlice Controller Configuration Parameters

The following tables describe the configuration parameters used to install the KubeSlice Controller. These parameters are required to create the KubeSlice Controller YAML file.

Parameter	Parameter Type	Description	Required
global	Object	This contains the configuration for global settings.	Mandatory
Kubeslice	Object	This contains the configuration for KubeSlice Controller.	Mandatory
Prometheus	Object	This contains the configuration for Prometheus server.	Mandatory
imagePullSecrets	Object	This contains the configuration to pull the Kubernetes dashboard image from.	Mandatory

Global Parameters

These parameters are required to create the KubeSlice Controller YAML file.

Parameter	Parameter Type	Description	Required
imageRegistry	String	The global image imageRegistry settings. The value must be docker.io/aveshasystems.	Mandatory
Profile	Object	This contains the configuration for OpenShift cluster.	Mandatory
kubeTally	Object	This contains the configuration for KubeTally.	Optional

Profile Parameters

Parameter	Parameter Type	Description	Required
openshift	String	This is the controller settings for OpenShift cluster.	Optional

KubeTally Parameters

The following table describes the configuration parameters used to enable cost management feature that is available on the KubeSlice Manager.

Parameter	Parameter Type	Description	Required
enabled	Boolean	This parameter value is set to false by default. If you want to use KubeTally, set the parameter value to true.	Optional
postgresAddr	String	The IP or URL of the Postgres database.	Mandatory
postgresPort	String	The port required to connect to the database.	Mandatory
postgresUser	String	The username required to connect to the database.	Mandatory
postgresPassword	String	The password required to connect to the database.	Mandatory
postgresDB	String	The database name.	Mandatory
priceServiceType	String	The service type for the price service type.	Mandatory
priceUpdaterWorkers	String	The number of workers for the price updater.	Mandatory
prometheusUrl	String	The Prometheus URL for monitoring.	Mandatory
dataProcessingHoursAgo	String	The data processing time window.	Mandatory
chargeUpdaterSchedule	String	The cron expression to schedule charge updater.	Mandatory
pricingUpdaterSchedule	String	The cron expression to schedule pricing updater.	Mandatory

KubeSlice Parameters

This parameter contains the configuration object used in the KubeSlice Controller YAML file.

Parameter	Parameter Type	Description	Required
controller	Object	This contains the configuration for the KubeSlice Controller.	Mandatory
prometheus	Object	This contains the configuration for Prometheus.	Mandatory
events	Object	This contains the configuration for events.	Optional
license	Object	This object describes the type of the license and its activation mode.	Optional

Controller Parameters

This object contains the different parameters used in the KubeSlice Controller YAML file.

Parameter	Parameter Type	Description	Required
loglevel	String	The log level of Controller. The default value is INFO. The other values are DEBUG or ERROR.	Optional
rbacResourcePrefix	String	The RBAC resource prefix.	Optional
projectnsPrefix	String	The project namespace prefix.	Optional
endpoint	AlphaNumeric	The URL of the Kubernetes control plane.	Mandatory
kubeTally	Object	The object that contains the kubeTally metrics cleanup interval.	Only mandatory for resource cost management
replication	Object	The object that contains the MinIO credentials required for replication slice.	Only mandatory for replication slice

KubeTally Parameters

Parameter	Parameter Type	Description	Required
enabled	Boolean	The default value is false. If you want to switch to KubeTally, set the value to true.	Optional

Replication Parameters

These parameters are required for installing MinIO that is a prerequisite for replication slice.

Parameter	Parameter Type	Description	Required
minio	Object	This object contains the credentials, storage, and the Boolean expression to install MinIO. This object is required for replication slice.	Only mandatory for replication slice

MinIO Parameters

These parameters are required for installing MinIO that is a prerequisite for replication slice.

Parameter	Parameter Type	Description	Required
install	Boolean	This is a Boolean expression to install MinIO and it must be set to true.	Only mandatory for replication slice
storage	String	This value is the storage of the MinIO bucket in the controller that must be set to 1Gi.	Only mandatory for replication slice
username	String	The user name you need to provide for installing MinIO.	Only mandatory for replication slice
password	String	The password you need to provide for installing MinIO.	Only mandatory for replication slice

Controller Prometheus Parameters

Parameter	Parameter Type	Description	Required
enabled	Boolean	This is a Boolean expression to enable the Prometheus server configuration. The value is true to enable the default Prometheus server.	Optional
url	String	This is the URL for the Prometheus service.	Optional

Controller Events Parameters

Parameter	Parameter Type	Description	Required
disabled	String	This is the Boolean expression to enabled to the Controller events. The default value is false. Set the value to true to enable the events.	Optional

Controller License Parameters

This object contains the different parameters used in the KubeSlice Controller YAML file.

Parameter	Parameter Type	Description	Required
type	String	The type of the license for installing KubeSlice. The value must be kubeslice-trial-license for a trial license and kubeslice-vcpu-license for an enterprise License.	Mandatory
mode	String	This is the license activation mode. For installing the KubeSlice Controller online, the value is auto, which is default. For installing the KubeSlice Controller on an airgap cluster, the value is manual.	Optional
customerName	String	Enter a name of the user or organization to easily identify.	Optional

Prometheus Configuration Parameters

These parameters are required to create the KubeSlice Controller YAML file.

Parameter Type	Parameter Type	Description	Required
imagePullSecrets	Object	The secrets tp pull the image.	Mandatory
configmapReload	Object	This contains the configuration for Prometheus config reloader.	Mandatory
server	Object	This contains the configuration for the Prometheus server.	Mandatory

ImagePull Secrets Parameters

Parameter Type	Parameter Type	Description	Required
name	String	This is the image name.	Mandatory

Prometheus ConfigMap Reload Parameters

Parameter Type	Parameter Type	Description	Required
configmapReload	Object	This contains the configuration for the Prometheus config reloader.	Optional

Prometheus Parameters

Parameter Type	Parameter Type	Description	Required
Prometheus	Object	This contains the configuration for the Prometheus Config Reloader image.	Optional

ConfigMap Reload Parameters

Parameter Type	Parameter Type	Description	Required
Image	Object	This contains the Prometheus configMap image details.	Optional

ConfigMap Reload Image Parameters

Parameter Type	Parameter Type	Description	Required
repository	String	The repository for the Prometheus config reloader image. The value must be docker.io/aveshasystems/prometheus-config-reloader.	Optional
tag	String	The tag for the Prometheus server image (uses appVersion from Chart.yaml if not set)	Optional
digest	String	The digest for the Prometheus server image (use tag if empty).	Optional
pullPolicy	String	The Pull policy for the Prometheus server image.	Optional

Prometheus Server Parameters

Parameter Type	Parameter Type	Description	Required
Image	Object	This contains the information of the Prometheus configuration.	Optional
service	Object	This contains the configuration for Prometheus server.	Optional
persistentVolume	Object	This contains the persistent volume configuration for Prometheus server.	Optional
retention	AlphaNumeric	This is the retention period for Prometheus. The default value is 30 days.	Optional

Prometheus Server Image Parameters

Parameter Type	Parameter Type	Description	Required
repository	String	The repository for the Prometheus server image. The value must be docker.io/aveshasystems/prometheus.	Optional
tag	String	The tag for the Prometheus server image (uses appVersion from Chart.yaml if not set).	Optional
digest	String	The digest for the Prometheus server image (use tag if empty).	Optional
pullPolicy	String	The Pull policy for the Prometheus server image.	Optional

Prometheus Service Parameters

Parameter Type	Parameter Type	Description	Required
type	String	The service type for the Prometheus server.	Optional

Prometheus PV Parameters

Parameter Type	Parameter Type	Description	Required
enabled	Boolean	This is the Boolean expression to enable or disable Persistent Volume claim (PVC) for Prometheus data.	Optional
statefulSetNameOverride	String	The override name for the created PVC (empty uses stateful set name).	Optional
accessModes	String	The access modes for the PVC.	Optional
labels	String	The labels for the PVC.	Optional
annotations	String	The annotations for the PVC.	Optional
existingClaim	String	The name of existing PVC to use (create manually if set).	Optional
mountPath	String	The mount path for Prometheus data.	Optional
size	AlphaNumeric	The size of the PVC.	Optional

Image Pull Secret Parameters

note

The values required for this section were supplied during the registration process. Refer to your registration email.

These parameters are required to access the repository to pull the image. They are configured in the KubeSlice Controller YAML file.

Parameter	Parameter Type	Description	Required
repository	String	This is the repository URL to pull the image from.Its value must always be https://index.docker.io/v1/.	Mandatory
username	String	This is your username to log in to the repository.	Mandatory
password	String	This is your user access token/password to log in to the repository.	Mandatory
email	String	This is your email address to log into the repository.	Mandatory

KubeSlice Manager Configuration Parameters

The following tables describe the configuration parameters required to install the KubeSlice Manager. They are configured in the KubeSlice Manager YAML file.

Parameter	Parameter Type	Description	Required
kubeTally	Object	This object contains the configuration required to enable KubeTally.	Optional
kubeslice	Object	This contains the configuration to pull the KubeSlice Manager and Kubernetes dashboard images from. This object also contains the proxy configuration to install the KubeSlice Manager.	Mandatory
imagePullSecrets	Object	This contains the secrets to access the repository to pull the KubeSlice image from.	Mandatory

KubeTally Parameters

The following tables describes the configuration parameters required to install KubeTally. They are configured in the KubeSlice Manager YAML file.

Parameter	Parameter Type	Description	Required
costApiUrl	String	This contains the URL to access KubeTally	Optional but mandatory for KubeTally
enabled	Boolean	This parameter enables KubeTally when it is set to true. The default value is false.	Mandatory only for KubeTally

KubeSlice Parameters

The following table describes the configuration parameters required to install the KubeSlice Manager. They are configured in the KubeSlice Manager YAML file.

Parameter	Parameter Type	Description	Required
dashboard	Object	This contains the configuration to pull the Kubernetes dashboard image from.	Mandatory
uiproxy	Object	This contains the configuration to pull the UI proxy configuration from.	Mandatory

Dashboard Parameters

This parameter is related to the Kubernetes dashboard that is installed as part of the KubeSlice Manager. It is configured in the KubeSlice Manager YAML file.

Parameter	Parameter Type	Description	Required
enable	Boolean	The default value is set to true. If you do not want the Kubernetes dashboard, then set this parameter value to false.	Optional

UI Proxy Parameters

These parameters describe the KubeSlice Manager proxy information configured in the KubeSlice Manager YAML file.

Parameter	Parameter Type	Description	Required
image	String	This is the URL of the image.	Mandatory
tag	String	This is a version of the image.	Mandatory
pullPolicy	String	This policy indicates the condition when the image is pulled.	Mandatory
service	Object	This indicates the type of the Kubernetes service.	Mandatory

Service Parameters

Parameter	Parameter Type	Description	Required
type	String	This is the type of the service in Kubernetes to access a logical set of pods.	Mandatory

KubeSlice Manager Image Pull Secret Parameters

These parameters are required to access the repository to pull the image. They are configured in the KubeSlice Manager YAML file.

Parameter	Parameter Type	Description	Required
repository	String	This is the repository URL to pull the image from.Its value must always be https://index.docker.io/v1/.	Mandatory
username	String	This is your username to log in to the repository.	Mandatory
password	String	This is your user access token/password to log in to the repository.	Mandatory
email	String	This is your email address to log into the repository.	Mandatory

Project Namespace Configuration Parameters

The following tables describe the parameters in the configuration file used to create the project namespace. These parameters are required for creating the project YAML file.

Parameter	Parameter Type	Description	Required
apiVersion	String	The KubeSlice Controller API version. The value must be controller.kubeslice.io/v1alpha1.	Mandatory
kind	String	The name of a Mandatory particular object schema. The value must be Project.	Mandatory
metadata	Object	The metadata describes the parameters (names and types) and attributes that have been applied.	Mandatory
spec	Object	The specification of the desired state of an object.	Mandatory

Project Metadata Parameters

These parameters are required for configuring the metadata in the project YAML file.

Parameter	Parameter Type	Description	Required
name	String	The name of the project you are creating. Each project should have a unique name.	Mandatory
namespace	String	The namespace on which you apply the project configuration file. The value must be kubeslice-controller.	Mandatory

Project Spec Parameters

This parameter object is required for configuring the specification in the project YAML file.

Parameter	Parameter Type	Description	Required
serviceAccount	Object	To specify permissions on the Project namespace.	Mandatory

Service Account Parameters

A service account provides an identity for running processes in application pods. It contains the list of users configured in the project YAML file.

Parameter	Parameter Type	Description	Required
readOnly	List of Strings	The user to be created with read-only permission.	Optional
readWrite	List of Strings	The user to be created with read-write permission.	Optional