mirror of https://github.com/k3d-io/k3d
Add support for ulimits (#1264)
dan-ash
1 year ago
committed by
GitHub
parent
3457b2f9c4
commit
88c5f18792
@ -0,0 +1,110 @@ |
||||
/* |
||||
Copyright © 2020-2022 The k3d Author(s) |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in |
||||
all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
THE SOFTWARE. |
||||
*/ |
||||
package util |
||||
|
||||
import ( |
||||
"strconv" |
||||
"strings" |
||||
|
||||
dockerunits "github.com/docker/go-units" |
||||
|
||||
"github.com/k3d-io/k3d/v5/pkg/config/v1alpha5" |
||||
l "github.com/k3d-io/k3d/v5/pkg/logger" |
||||
) |
||||
|
||||
type UlimitTypes interface { |
||||
dockerunits.Ulimit | v1alpha5.Ulimit |
||||
} |
||||
|
||||
type Ulimit[T UlimitTypes] struct { |
||||
Values T |
||||
} |
||||
|
||||
// ValidateRuntimeUlimitKey validates a given ulimit key is valid
|
||||
func ValidateRuntimeUlimitKey(ulimitKey string) { |
||||
ulimitsKeys := map[string]bool{ |
||||
"core": true, |
||||
"cpu": true, |
||||
"data": true, |
||||
"fsize": true, |
||||
"locks": true, |
||||
"memlock": true, |
||||
"msgqueue": true, |
||||
"nice": true, |
||||
"nofile": true, |
||||
"nproc": true, |
||||
"rss": true, |
||||
"rtprio": true, |
||||
"rttime": true, |
||||
"sigpending": true, |
||||
"stack": true, |
||||
} |
||||
keysList := make([]string, 0, len(ulimitsKeys)) |
||||
|
||||
for key := range ulimitsKeys { |
||||
keysList = append(keysList, key) |
||||
} |
||||
if !ulimitsKeys[ulimitKey] { |
||||
l.Log().Fatalf("runtime ulimit \"%s\" is not valid, allowed keys are: %s", ulimitKey, strings.Join(keysList, ", ")) |
||||
} |
||||
} |
||||
|
||||
func ParseRuntimeUlimit[T UlimitTypes](ulimit string) *T { |
||||
var parsedUlimit any |
||||
var tmpUlimit Ulimit[T] |
||||
ulimitSplitted := strings.Split(ulimit, "=") |
||||
if len(ulimitSplitted) != 2 { |
||||
l.Log().Fatalf("unknown runtime-ulimit format format: %s, use format \"ulimit=soft:hard\"", ulimit) |
||||
} |
||||
ValidateRuntimeUlimitKey(ulimitSplitted[0]) |
||||
softHardSplitted := strings.Split(ulimitSplitted[1], ":") |
||||
if len(softHardSplitted) != 2 { |
||||
l.Log().Fatalf("unknown runtime-ulimit format format: %s, use format \"ulimit=soft:hard\"", ulimit) |
||||
} |
||||
soft, err := strconv.Atoi(softHardSplitted[0]) |
||||
if err != nil { |
||||
l.Log().Fatalf("unknown runtime-ulimit format format: soft %s has to be int", ulimitSplitted[0]) |
||||
} |
||||
hard, err := strconv.Atoi(softHardSplitted[1]) |
||||
if err != nil { |
||||
l.Log().Fatalf("unknown runtime-ulimit format format: hard %s has to be int", ulimitSplitted[1]) |
||||
} |
||||
|
||||
switch any(tmpUlimit.Values).(type) { |
||||
case dockerunits.Ulimit: |
||||
parsedUlimit = &dockerunits.Ulimit{ |
||||
Name: ulimitSplitted[0], |
||||
Soft: int64(soft), |
||||
Hard: int64(hard), |
||||
} |
||||
case v1alpha5.Ulimit: |
||||
parsedUlimit = &v1alpha5.Ulimit{ |
||||
Name: ulimitSplitted[0], |
||||
Soft: int64(soft), |
||||
Hard: int64(hard), |
||||
} |
||||
default: |
||||
l.Log().Fatalf("Unsupported UlimitTypes, supported types are: dockerunits.Ulimit or v1alpha5.Ulimit") |
||||
} |
||||
|
||||
return parsedUlimit.(*T) |
||||
} |
||||
@ -0,0 +1,56 @@ |
||||
apiVersion: k3d.io/v1alpha5 |
||||
kind: Simple |
||||
metadata: |
||||
name: test |
||||
servers: 3 |
||||
agents: 2 |
||||
kubeAPI: |
||||
hostIP: "0.0.0.0" |
||||
hostPort: "6446" |
||||
#image: rancher/k3s:latest |
||||
volumes: |
||||
- volume: /my/path:/some/path |
||||
nodeFilters: |
||||
- all |
||||
ports: |
||||
- port: 80:80 |
||||
nodeFilters: |
||||
- loadbalancer |
||||
- port: 0.0.0.0:443:443 |
||||
nodeFilters: |
||||
- loadbalancer |
||||
env: |
||||
- envVar: bar=baz,bob |
||||
nodeFilters: |
||||
- all |
||||
registries: |
||||
create: |
||||
name: k3d-test-registry |
||||
host: "0.0.0.0" |
||||
hostPort: random |
||||
config: | |
||||
mirrors: |
||||
"my.company.registry": |
||||
endpoint: |
||||
- http://my.company.registry:5000 |
||||
|
||||
options: |
||||
k3d: |
||||
wait: true |
||||
timeout: "360s" # should be pretty high for multi-server clusters to allow for a proper startup routine |
||||
disableLoadbalancer: false |
||||
disableImageVolume: false |
||||
k3s: |
||||
extraArgs: |
||||
- arg: --tls-san=127.0.0.1 |
||||
nodeFilters: |
||||
- server:* |
||||
kubeconfig: |
||||
updateDefaultKubeconfig: true |
||||
switchCurrentContext: true |
||||
runtime: |
||||
labels: |
||||
- label: foo=bar |
||||
nodeFilters: |
||||
- server:0 |
||||
- loadbalancer |
||||
@ -1,3 +1,3 @@ |
||||
apiVersion: k3d.io/v1alpha4 |
||||
apiVersion: k3d.io/v1alpha5 |
||||
kind: Unknown |
||||
foo: bar |
||||
|
||||
@ -0,0 +1,116 @@ |
||||
/* |
||||
Copyright © 2020-2022 The k3d Author(s) |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in |
||||
all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
THE SOFTWARE. |
||||
*/ |
||||
|
||||
package v1alpha5 |
||||
|
||||
import ( |
||||
"encoding/json" |
||||
"fmt" |
||||
|
||||
configtypes "github.com/k3d-io/k3d/v5/pkg/config/types" |
||||
"github.com/k3d-io/k3d/v5/pkg/config/v1alpha2" |
||||
"github.com/k3d-io/k3d/v5/pkg/config/v1alpha3" |
||||
"github.com/k3d-io/k3d/v5/pkg/config/v1alpha4" |
||||
l "github.com/k3d-io/k3d/v5/pkg/logger" |
||||
) |
||||
|
||||
var Migrations = map[string]func(configtypes.Config) (configtypes.Config, error){ |
||||
v1alpha2.ApiVersion: MigrateV1Alpha2, |
||||
v1alpha3.ApiVersion: MigrateV1Alpha3, |
||||
v1alpha4.ApiVersion: MigrateV1Alpha4, |
||||
} |
||||
|
||||
func MigrateV1Alpha2(input configtypes.Config) (configtypes.Config, error) { |
||||
l.Log().Debugln("Migrating v1alpha2 to v1alpha3") |
||||
|
||||
// first, migrate to v1alpha3
|
||||
input, err := v1alpha3.MigrateV1Alpha2(input) |
||||
if err != nil { |
||||
return nil, fmt.Errorf("error migration v1alpha2 to v1alpha3: %w", err) |
||||
} |
||||
|
||||
// then, migrate to v1alpha4
|
||||
input, err = v1alpha4.MigrateV1Alpha3(input) |
||||
if err != nil { |
||||
return nil, fmt.Errorf("error migration v1alpha3 to v1alpha4: %w", err) |
||||
} |
||||
|
||||
// then, migrate to v1alpha5
|
||||
return MigrateV1Alpha4(input) |
||||
} |
||||
|
||||
func MigrateV1Alpha3(input configtypes.Config) (configtypes.Config, error) { |
||||
l.Log().Debugln("Migrating v1alpha3 to v1alpha4") |
||||
// first, migrate to v1alpha4
|
||||
input, err := v1alpha4.MigrateV1Alpha3(input) |
||||
if err != nil { |
||||
return nil, fmt.Errorf("error migration v1alpha3 to v1alpha4: %w", err) |
||||
} |
||||
// then, migrate to v1alpha5
|
||||
return MigrateV1Alpha4(input) |
||||
} |
||||
|
||||
func MigrateV1Alpha4(input configtypes.Config) (configtypes.Config, error) { |
||||
l.Log().Debugln("Migrating v1alpha4 to v1alpha5") |
||||
/* |
||||
* We're migrating matching fields between versions by marshalling to JSON and back |
||||
*/ |
||||
injson, err := json.Marshal(input) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
/* |
||||
* Migrate config of `kind: Simple` |
||||
*/ |
||||
if input.GetKind() == "Simple" { |
||||
cfgIntermediate := v1alpha4.SimpleConfig{} |
||||
if err := json.Unmarshal(injson, &cfgIntermediate); err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
intermediateJSON, err := json.Marshal(cfgIntermediate) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
cfg := SimpleConfig{} |
||||
if err := json.Unmarshal(intermediateJSON, &cfg); err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
cfg.Name = cfgIntermediate.Name |
||||
|
||||
/* |
||||
* Finalizing |
||||
*/ |
||||
|
||||
cfg.APIVersion = ApiVersion |
||||
|
||||
l.Log().Debugf("Migrated config: %+v", cfg) |
||||
|
||||
return cfg, nil |
||||
} |
||||
|
||||
l.Log().Debugf("No migration needed for %s#%s -> %s#%s", input.GetAPIVersion(), input.GetKind(), ApiVersion, input.GetKind()) |
||||
|
||||
return input, nil |
||||
} |
||||
@ -0,0 +1,405 @@ |
||||
{ |
||||
"$schema": "http://json-schema.org/draft-07/schema#", |
||||
"title": "SimpleConfig", |
||||
"type": "object", |
||||
"required": [ |
||||
"apiVersion", |
||||
"kind" |
||||
], |
||||
"properties": { |
||||
"apiVersion": { |
||||
"type": "string", |
||||
"enum": [ |
||||
"k3d.io/v1alpha5" |
||||
], |
||||
"default": "k3d.io/v1alpha5" |
||||
}, |
||||
"kind": { |
||||
"type": "string", |
||||
"enum": [ |
||||
"Simple" |
||||
], |
||||
"default": "Simple" |
||||
}, |
||||
"metadata": { |
||||
"type": "object", |
||||
"properties": { |
||||
"name": { |
||||
"description": "Name of the cluster (must be a valid hostname and will be prefixed with 'k3d-'). Example: 'mycluster'.", |
||||
"type": "string", |
||||
"format": "hostname" |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
}, |
||||
"servers": { |
||||
"type": "number", |
||||
"minimum": 1 |
||||
}, |
||||
"agents": { |
||||
"type": "number", |
||||
"minimum": 0 |
||||
}, |
||||
"kubeAPI": { |
||||
"type": "object", |
||||
"properties": { |
||||
"host": { |
||||
"type": "string", |
||||
"format": "hostname" |
||||
}, |
||||
"hostIP": { |
||||
"type": "string", |
||||
"format": "ipv4", |
||||
"examples": [ |
||||
"0.0.0.0", |
||||
"192.168.178.55" |
||||
] |
||||
}, |
||||
"hostPort": { |
||||
"type": "string", |
||||
"examples": [ |
||||
"6443" |
||||
] |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
}, |
||||
"image": { |
||||
"type": "string", |
||||
"examples": [ |
||||
"rancher/k3s:latest" |
||||
] |
||||
}, |
||||
"network": { |
||||
"type": "string" |
||||
}, |
||||
"subnet": { |
||||
"type": "string", |
||||
"default": "auto", |
||||
"examples": [ |
||||
"172.28.0.0/16", |
||||
"192.162.0.0/16" |
||||
] |
||||
}, |
||||
"token": { |
||||
"type": "string" |
||||
}, |
||||
"volumes": { |
||||
"type": "array", |
||||
"items": { |
||||
"type": "object", |
||||
"properties": { |
||||
"volume": { |
||||
"type": "string" |
||||
}, |
||||
"nodeFilters": { |
||||
"$ref": "#/definitions/nodeFilters" |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
} |
||||
}, |
||||
"ports": { |
||||
"type": "array", |
||||
"items": { |
||||
"type": "object", |
||||
"properties": { |
||||
"port": { |
||||
"type": "string" |
||||
}, |
||||
"nodeFilters": { |
||||
"$ref": "#/definitions/nodeFilters" |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
} |
||||
}, |
||||
"options": { |
||||
"type": "object", |
||||
"properties": { |
||||
"k3d": { |
||||
"type": "object", |
||||
"properties": { |
||||
"wait": { |
||||
"type": "boolean", |
||||
"default": true |
||||
}, |
||||
"timeout": { |
||||
"examples": [ |
||||
"60s", |
||||
"1m", |
||||
"1m30s" |
||||
] |
||||
}, |
||||
"disableLoadbalancer": { |
||||
"type": "boolean", |
||||
"default": false |
||||
}, |
||||
"disableImageVolume": { |
||||
"type": "boolean", |
||||
"default": false |
||||
}, |
||||
"disableRollback": { |
||||
"type": "boolean", |
||||
"default": false |
||||
}, |
||||
"loadbalancer": { |
||||
"type": "object", |
||||
"properties": { |
||||
"configOverrides": { |
||||
"type": "array", |
||||
"examples": [ |
||||
"settings.workerConnections=2048", |
||||
"settings.defaultProxyTimeout=900" |
||||
] |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
}, |
||||
"k3s": { |
||||
"type": "object", |
||||
"properties": { |
||||
"extraArgs": { |
||||
"type": "array", |
||||
"items": { |
||||
"type": "object", |
||||
"properties": { |
||||
"arg": { |
||||
"type": "string", |
||||
"examples": [ |
||||
"--tls-san=127.0.0.1", |
||||
"--disable=traefik" |
||||
] |
||||
}, |
||||
"nodeFilters": { |
||||
"$ref": "#/definitions/nodeFilters" |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
} |
||||
}, |
||||
"nodeLabels": { |
||||
"type": "array", |
||||
"items": { |
||||
"type": "object", |
||||
"properties": { |
||||
"label": { |
||||
"type": "string" |
||||
}, |
||||
"nodeFilters": { |
||||
"$ref": "#/definitions/nodeFilters" |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
} |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
}, |
||||
"kubeconfig": { |
||||
"type": "object", |
||||
"properties": { |
||||
"updateDefaultKubeconfig": { |
||||
"type": "boolean", |
||||
"default": true |
||||
}, |
||||
"switchCurrentContext": { |
||||
"type": "boolean", |
||||
"default": true |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
}, |
||||
"runtime": { |
||||
"type": "object", |
||||
"properties": { |
||||
"gpuRequest": { |
||||
"type": "string" |
||||
}, |
||||
"serversMemory": { |
||||
"type": "string" |
||||
}, |
||||
"agentsMemory": { |
||||
"type": "string" |
||||
}, |
||||
"hostPidMode": { |
||||
"type": "boolean", |
||||
"default": false |
||||
}, |
||||
"labels": { |
||||
"type": "array", |
||||
"items": { |
||||
"type": "object", |
||||
"properties": { |
||||
"label": { |
||||
"type": "string" |
||||
}, |
||||
"nodeFilters": { |
||||
"$ref": "#/definitions/nodeFilters" |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
} |
||||
}, |
||||
"ulimits": { |
||||
"type": "array", |
||||
"items": { |
||||
"type": "object", |
||||
"properties": { |
||||
"name": { |
||||
"type": "string" |
||||
}, |
||||
"soft": { |
||||
"type": "number" |
||||
}, |
||||
"hard": { |
||||
"type": "number" |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
}, |
||||
"env": { |
||||
"type": "array", |
||||
"items": { |
||||
"type": "object", |
||||
"properties": { |
||||
"envVar": { |
||||
"type": "string" |
||||
}, |
||||
"nodeFilters": { |
||||
"$ref": "#/definitions/nodeFilters" |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
} |
||||
}, |
||||
"registries": { |
||||
"type": "object", |
||||
"properties": { |
||||
"create": { |
||||
"type": "object", |
||||
"description": "Create a new container image registry alongside the cluster.", |
||||
"properties": { |
||||
"name": { |
||||
"type": "string", |
||||
"examples": [ |
||||
"myregistry", |
||||
"registry.localhost" |
||||
] |
||||
}, |
||||
"host": { |
||||
"type": "string", |
||||
"examples": [ |
||||
"0.0.0.0", |
||||
"localhost", |
||||
"127.0.0.1" |
||||
], |
||||
"default": "0.0.0.0" |
||||
}, |
||||
"hostPort": { |
||||
"type": "string", |
||||
"examples": [ |
||||
"5000", |
||||
"2345" |
||||
], |
||||
"default": "random" |
||||
}, |
||||
"image": { |
||||
"type": "string", |
||||
"examples": [ |
||||
"myregistry/registry:2" |
||||
], |
||||
"default": "docker.io/library/registry:2" |
||||
}, |
||||
"proxy": { |
||||
"type": "object", |
||||
"properties": { |
||||
"remoteURL": { |
||||
"type": "string", |
||||
"examples": [ |
||||
"https://registry-1.docker.io" |
||||
] |
||||
}, |
||||
"username": { |
||||
"type": "string" |
||||
}, |
||||
"password": { |
||||
"type": "string" |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
}, |
||||
"volumes": { |
||||
"type": "array", |
||||
"items": { |
||||
"type": "string" |
||||
}, |
||||
"examples": [ |
||||
"/tmp/registry:/var/lib/registry" |
||||
] |
||||
} |
||||
}, |
||||
"additionalProperties": false |
||||
}, |
||||
"use": { |
||||
"type": "array", |
||||
"description": "Connect another container image registry to the cluster.", |
||||
"items": { |
||||
"type": "string" |
||||
}, |
||||
"examples": [ |
||||
"otherregistry:5000" |
||||
] |
||||
}, |
||||
"config": { |
||||
"type": "string", |
||||
"description": "Reference a K3s registry configuration file or at it's contents here." |
||||
}, |
||||
"additionalProperties": false |
||||
} |
||||
}, |
||||
"hostAliases": { |
||||
"type": "array", |
||||
"description": "Additional IP to multiple hostnames mappings", |
||||
"items": { |
||||
"type": "object", |
||||
"properties": { |
||||
"ip": { |
||||
"type": "string" |
||||
}, |
||||
"hostnames": { |
||||
"type": "array", |
||||
"items": { |
||||
"type": "string" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"additionalProperties": false, |
||||
"definitions": { |
||||
"nodeFilters": { |
||||
"type": "array", |
||||
"items": { |
||||
"type": "string" |
||||
}, |
||||
"examples": [ |
||||
"loadbalancer", |
||||
"server:*", |
||||
"server:0", |
||||
"agent:1", |
||||
"all" |
||||
] |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,229 @@ |
||||
/* |
||||
Copyright © 2020-2022 The k3d Author(s) |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in |
||||
all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
THE SOFTWARE. |
||||
*/ |
||||
|
||||
package v1alpha5 |
||||
|
||||
import ( |
||||
_ "embed" |
||||
"fmt" |
||||
"strings" |
||||
"time" |
||||
|
||||
config "github.com/k3d-io/k3d/v5/pkg/config/types" |
||||
k3d "github.com/k3d-io/k3d/v5/pkg/types" |
||||
"github.com/k3d-io/k3d/v5/version" |
||||
) |
||||
|
||||
const ApiVersion = "k3d.io/v1alpha5" |
||||
|
||||
// JSONSchema describes the schema used to validate config files
|
||||
//go:embed schema.json
|
||||
var JSONSchema string |
||||
|
||||
// DefaultConfigTpl for printing
|
||||
const DefaultConfigTpl = `--- |
||||
apiVersion: k3d.io/v1alpha5 |
||||
kind: Simple |
||||
metadata: |
||||
name: %s |
||||
servers: 1 |
||||
agents: 0 |
||||
image: %s |
||||
` |
||||
|
||||
// DefaultConfig templated DefaultConfigTpl
|
||||
var DefaultConfig = fmt.Sprintf( |
||||
DefaultConfigTpl, |
||||
k3d.DefaultClusterName, |
||||
fmt.Sprintf("%s:%s", k3d.DefaultK3sImageRepo, version.K3sVersion), |
||||
) |
||||
|
||||
type VolumeWithNodeFilters struct { |
||||
Volume string `mapstructure:"volume" json:"volume,omitempty"` |
||||
NodeFilters []string `mapstructure:"nodeFilters" json:"nodeFilters,omitempty"` |
||||
} |
||||
|
||||
type PortWithNodeFilters struct { |
||||
Port string `mapstructure:"port" json:"port,omitempty"` |
||||
NodeFilters []string `mapstructure:"nodeFilters" json:"nodeFilters,omitempty"` |
||||
} |
||||
|
||||
type LabelWithNodeFilters struct { |
||||
Label string `mapstructure:"label" json:"label,omitempty"` |
||||
NodeFilters []string `mapstructure:"nodeFilters" json:"nodeFilters,omitempty"` |
||||
} |
||||
|
||||
type EnvVarWithNodeFilters struct { |
||||
EnvVar string `mapstructure:"envVar" json:"envVar,omitempty"` |
||||
NodeFilters []string `mapstructure:"nodeFilters" json:"nodeFilters,omitempty"` |
||||
} |
||||
|
||||
type K3sArgWithNodeFilters struct { |
||||
Arg string `mapstructure:"arg" json:"arg,omitempty"` |
||||
NodeFilters []string `mapstructure:"nodeFilters" json:"nodeFilters,omitempty"` |
||||
} |
||||
|
||||
type SimpleConfigRegistryCreateConfig struct { |
||||
Name string `mapstructure:"name" json:"name,omitempty"` |
||||
Host string `mapstructure:"host" json:"host,omitempty"` |
||||
HostPort string `mapstructure:"hostPort" json:"hostPort,omitempty"` |
||||
Image string `mapstructure:"image" json:"image,omitempty"` |
||||
Proxy k3d.RegistryProxy `mapstructure:"proxy" json:"proxy,omitempty"` |
||||
Volumes []string `mapstructure:"volumes" json:"volumes,omitempty"` |
||||
} |
||||
|
||||
// SimpleConfigOptionsKubeconfig describes the set of options referring to the kubeconfig during cluster creation.
|
||||
type SimpleConfigOptionsKubeconfig struct { |
||||
UpdateDefaultKubeconfig bool `mapstructure:"updateDefaultKubeconfig" json:"updateDefaultKubeconfig,omitempty"` // default: true
|
||||
SwitchCurrentContext bool `mapstructure:"switchCurrentContext" json:"switchCurrentContext,omitempty"` //nolint:lll // default: true
|
||||
} |
||||
|
||||
type SimpleConfigOptions struct { |
||||
K3dOptions SimpleConfigOptionsK3d `mapstructure:"k3d" json:"k3d"` |
||||
K3sOptions SimpleConfigOptionsK3s `mapstructure:"k3s" json:"k3s"` |
||||
KubeconfigOptions SimpleConfigOptionsKubeconfig `mapstructure:"kubeconfig" json:"kubeconfig"` |
||||
Runtime SimpleConfigOptionsRuntime `mapstructure:"runtime" json:"runtime"` |
||||
} |
||||
|
||||
type SimpleConfigOptionsRuntime struct { |
||||
GPURequest string `mapstructure:"gpuRequest" json:"gpuRequest,omitempty"` |
||||
ServersMemory string `mapstructure:"serversMemory" json:"serversMemory,omitempty"` |
||||
AgentsMemory string `mapstructure:"agentsMemory" json:"agentsMemory,omitempty"` |
||||
HostPidMode bool `mapstructure:"hostPidMode" yjson:"hostPidMode,omitempty"` |
||||
Labels []LabelWithNodeFilters `mapstructure:"labels" json:"labels,omitempty"` |
||||
Ulimits []Ulimit `mapstructure:"ulimits" json:"ulimits,omitempty"` |
||||
} |
||||
|
||||
type Ulimit struct { |
||||
Name string `mapstructure:"name" json:"name"` |
||||
Soft int64 `mapstructure:"soft" json:"soft"` |
||||
Hard int64 `mapstructure:"hard" json:"hard"` |
||||
} |
||||
|
||||
type SimpleConfigOptionsK3d struct { |
||||
Wait bool `mapstructure:"wait" json:"wait"` |
||||
Timeout time.Duration `mapstructure:"timeout" json:"timeout,omitempty"` |
||||
DisableLoadbalancer bool `mapstructure:"disableLoadbalancer" json:"disableLoadbalancer"` |
||||
DisableImageVolume bool `mapstructure:"disableImageVolume" json:"disableImageVolume"` |
||||
NoRollback bool `mapstructure:"disableRollback" json:"disableRollback"` |
||||
NodeHookActions []k3d.NodeHookAction `mapstructure:"nodeHookActions" json:"nodeHookActions,omitempty"` |
||||
Loadbalancer SimpleConfigOptionsK3dLoadbalancer `mapstructure:"loadbalancer" json:"loadbalancer,omitempty"` |
||||
} |
||||
|
||||
type SimpleConfigOptionsK3dLoadbalancer struct { |
||||
ConfigOverrides []string `mapstructure:"configOverrides" json:"configOverrides,omitempty"` |
||||
} |
||||
|
||||
type SimpleConfigOptionsK3s struct { |
||||
ExtraArgs []K3sArgWithNodeFilters `mapstructure:"extraArgs" json:"extraArgs,omitempty"` |
||||
NodeLabels []LabelWithNodeFilters `mapstructure:"nodeLabels" json:"nodeLabels,omitempty"` |
||||
} |
||||
|
||||
type SimpleConfigRegistries struct { |
||||
Use []string `mapstructure:"use" json:"use,omitempty"` |
||||
Create *SimpleConfigRegistryCreateConfig `mapstructure:"create" json:"create,omitempty"` |
||||
Config string `mapstructure:"config" json:"config,omitempty"` // registries.yaml (k3s config for containerd registry override)
|
||||
} |
||||
|
||||
// SimpleConfig describes the toplevel k3d configuration file.
|
||||
type SimpleConfig struct { |
||||
config.TypeMeta `mapstructure:",squash"` |
||||
config.ObjectMeta `mapstructure:"metadata" json:"metadata,omitempty"` |
||||
Servers int `mapstructure:"servers" json:"servers,omitempty"` //nolint:lll // default 1
|
||||
Agents int `mapstructure:"agents" json:"agents,omitempty"` //nolint:lll // default 0
|
||||
ExposeAPI SimpleExposureOpts `mapstructure:"kubeAPI" json:"kubeAPI,omitempty"` |
||||
Image string `mapstructure:"image" json:"image,omitempty"` |
||||
Network string `mapstructure:"network" json:"network,omitempty"` |
||||
Subnet string `mapstructure:"subnet" json:"subnet,omitempty"` |
||||
ClusterToken string `mapstructure:"token" json:"clusterToken,omitempty"` // default: auto-generated
|
||||
Volumes []VolumeWithNodeFilters `mapstructure:"volumes" json:"volumes,omitempty"` |
||||
Ports []PortWithNodeFilters `mapstructure:"ports" json:"ports,omitempty"` |
||||
Options SimpleConfigOptions `mapstructure:"options" json:"options,omitempty"` |
||||
Env []EnvVarWithNodeFilters `mapstructure:"env" json:"env,omitempty"` |
||||
Registries SimpleConfigRegistries `mapstructure:"registries" json:"registries,omitempty"` |
||||
HostAliases []k3d.HostAlias `mapstructure:"hostAliases" json:"hostAliases,omitempty"` |
||||
} |
||||
|
||||
// SimpleExposureOpts provides a simplified syntax compared to the original k3d.ExposureOpts
|
||||
type SimpleExposureOpts struct { |
||||
Host string `mapstructure:"host" json:"host,omitempty"` |
||||
HostIP string `mapstructure:"hostIP" json:"hostIP,omitempty"` |
||||
HostPort string `mapstructure:"hostPort" json:"hostPort,omitempty"` |
||||
} |
||||
|
||||
// GetKind implements Config.GetKind
|
||||
func (c SimpleConfig) GetKind() string { |
||||
return "Simple" |
||||
} |
||||
|
||||
func (c SimpleConfig) GetAPIVersion() string { |
||||
return ApiVersion |
||||
} |
||||
|
||||
// ClusterConfig describes a single cluster config
|
||||
type ClusterConfig struct { |
||||
config.TypeMeta `mapstructure:",squash"` |
||||
k3d.Cluster `mapstructure:",squash"` |
||||
ClusterCreateOpts k3d.ClusterCreateOpts `mapstructure:"options" json:"options"` |
||||
KubeconfigOpts SimpleConfigOptionsKubeconfig `mapstructure:"kubeconfig" json:"kubeconfig"` |
||||
} |
||||
|
||||
// GetKind implements Config.GetKind
|
||||
func (c ClusterConfig) GetKind() string { |
||||
return "Simple" |
||||
} |
||||
|
||||
func (c ClusterConfig) GetAPIVersion() string { |
||||
return ApiVersion |
||||
} |
||||
|
||||
// ClusterListConfig describes a list of clusters
|
||||
type ClusterListConfig struct { |
||||
config.TypeMeta `mapstructure:",squash"` |
||||
Clusters []k3d.Cluster `mapstructure:"clusters" json:"clusters"` |
||||
} |
||||
|
||||
func (c ClusterListConfig) GetKind() string { |
||||
return "Simple" |
||||
} |
||||
|
||||
func (c ClusterListConfig) GetAPIVersion() string { |
||||
return ApiVersion |
||||
} |
||||
|
||||
func GetConfigByKind(kind string) (config.Config, error) { |
||||
|
||||
// determine config kind
|
||||
switch strings.ToLower(kind) { |
||||
case "simple": |
||||
return SimpleConfig{}, nil |
||||
case "cluster": |
||||
return ClusterConfig{}, nil |
||||
case "clusterlist": |
||||
return ClusterListConfig{}, nil |
||||
case "": |
||||
return nil, fmt.Errorf("missing `kind` in config file") |
||||
default: |
||||
return nil, fmt.Errorf("unknown `kind` '%s' in config file", kind) |
||||
} |
||||
|
||||
} |
||||
Loading…
Reference in new issue