Settings

Enable/disable HobbyFarm features by adjusting settings.

HobbyFarm makes use of adjustable settings to alter the behavior of the platform by adding or removing features via feature-gates or by setting variables, such as the retention time of specific objects.

Settings always have a name and a scope. The name provides a unique identifier for the setting while the scope defines who can adjust settings as well as who can retrieve the settings.

All settings are dynamically rendered in the Admin-UI under the Configuration > Settings page.

Kubernetes Commands

The following commands are useful for managing Setting resources in Kubernetes.

## Get a list of all Settings
kubectl get settings -n hobbyfarm-system

## Create a Setting from a YAML manifest
kubectl apply -f {settingManifest} -n hobbyfarm-system

## Edit a Setting
kubectl edit setting {settingName} -n hobbyfarm-system

## Backup a Setting to a YAML manifest
kubectl get setting {settingName} -n hobbyfarm-system -o yaml > {settingManifest}

## Delete a Setting
kubectl delete setting {settingName} -n hobbyfarm-system

Example Setting Manifests

The following are three example Settings manifests.

## Boolean dataType using a scalar.
## Assigned to the public scope.
apiVersion: hobbyfarm.io/v1
dataType: boolean
kind: Setting
metadata:
  labels:
    hobbyfarm.io/setting-scope: public
  name: registration-disabled
  namespace: hobbyfarm
value: "true"
valueType: scalar

---

## String dataType using an array with validators.
## Assigned to the admin-ui scope.
apiVersion: hobbyfarm.io/v1
dataType: string
displayName: String Array
kind: Setting
metadata:
  labels:
    hobbyfarm.io/setting-group: my-group
    hobbyfarm.io/setting-scope: admin-ui
  name: string-array
value: '["string","array"]'
valueType: array
minLength: 2
maxLength: 4

---

## String dataType using an enum.
## Assigned to the user-ui scope.
apiVersion: hobbyfarm.io/v1
dataType: string
kind: Setting
metadata:
  labels:
    hobbyfarm.io/setting-scope: user-ui
  name: enum-setting
  namespace: hobbyfarm
value: "abc"
enum: ["xyz", "abc", "def"]
valueType: scalar

Default Settings

HobbyFarm ships with the following default settings. If these settings are removed, they will be automatically recreated.

Name	Display Name	Scope	Default Value
motd-admin-ui	Admin UI MOTD	admin-ui	none
motd-ui	User UI MOTD	public	none
registration-disabled	Registration disabled	public	false

Configuration

`dataTypes`

Settings dataType values can be of one of four types:

dataType	Example	Description
string	“Hello World”	A sequence of characters.
integer	123	A whole number.
float	123.456	A number with a decimal point.
boolean	true	A value which is either `true` or `false`.

`valueTypes`

Settings valueType values can be one of three types:

valueType	Example	Description
scalar	“Hello World”	A single value.
array	[“Hello”, “World”]	A list of values.
map	{“key”: “value”}	A key/value pair.

`validators`

Settings may also include Validators.

Validator	Example	Description
required	true	The value must be set.
maximum	100	The value must be less than or equal to the maximum value.
minimum	0	The value must be greater than or equal to the minimum value.
maxLength	10	The value must be less than or equal to the maximum length.
minLength	0	The value must be greater than or equal to the minimum length.
format	“ipv4”	The value must match the format.
pattern	“^[a-z]+$”	The value must match the pattern.
enum	[“a”, “b”, “c”]	The value must be one of the enum values.
default	“Hello World”	The value will be set to the default value if not set.
uniqueItems	true	The value must be unique.

Please see the Gargantua Property Types for a full list of and corresponding data types.

Scopes

Settings work in conjunction with Scopes. Please see the Scopes documentation for more information.