install

Documentation

Overview

Copyright 2021 k0s authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 k0s Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 k0s Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 k0s Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func CreateControllerUsers(clusterConfig *v1beta1.ClusterConfig, k0sVars constant.CfgVars) error
• func CreateUser(userName string, homeDir string, shell string) error
• func DeleteControllerUsers(clusterConfig *v1beta1.ClusterConfig) error
• func DeleteUser(userName string) error
• func EnsureService(args []string) error
• func EnsureUser(name string, homeDir string) error
• func GetRoleByPID(pid int) (role string, err error)
• func GetRoleByStagedKubelet(binPath string) string
• func GetSysInit(role string) (sysInitPlatform string, stubFile string, err error)
• func UninstallService(role string) error
• type CleanUpConfig
  • func NewCleanUpConfig(dataDir string) *CleanUpConfig
  • func (c *CleanUpConfig) RemoveAllDirectories() error
  • func (c *CleanUpConfig) WorkerCleanup() error
• type K0sStatus
  • func GetPid() (status *K0sStatus, err error)
  • func (s K0sStatus) GetK0sVersion() (string, error)
  • func (s K0sStatus) String()

Functions

func CreateControllerUsers

func CreateControllerUsers(clusterConfig *v1beta1.ClusterConfig, k0sVars constant.CfgVars) error

CreateControllerUsers accepts a cluster config, and cfgVars and creates controller users accordingly

func CreateUser

func CreateUser(userName string, homeDir string, shell string) error

CreateUser creates a system user with either `adduser` or `useradd` command

func DeleteControllerUsers

func DeleteControllerUsers(clusterConfig *v1beta1.ClusterConfig) error

CreateControllerUsers accepts a cluster config, and cfgVars and creates controller users accordingly

func DeleteUser

func DeleteUser(userName string) error

DeleteUser deletes system users with either `deluser` or `userdel` command

func EnsureService

func EnsureService(args []string) error

EnsureService installs the k0s service, per the given arguments, and the detected platform

func EnsureUser

func EnsureUser(name string, homeDir string) error

EnsureUser checks if a user exists, and creates it, if it doesn't TODO: we should also consider modifying the user, if the user exists, but with wrong settings

func GetRoleByPID

func GetRoleByPID(pid int) (role string, err error)

func GetRoleByStagedKubelet

func GetRoleByStagedKubelet(binPath string) string

This function attempts to find out the host role, by staged binaries

func GetSysInit

func GetSysInit(role string) (sysInitPlatform string, stubFile string, err error)

GetSysInit returns the sys init platform name, and the stub file path for a system

func UninstallService

func UninstallService(role string) error

Types

type CleanUpConfig

type CleanUpConfig struct {
	// contains filtered or unexported fields
}

func NewCleanUpConfig

func NewCleanUpConfig(dataDir string) *CleanUpConfig

func (*CleanUpConfig) RemoveAllDirectories

func (c *CleanUpConfig) RemoveAllDirectories() error

func (*CleanUpConfig) WorkerCleanup

func (c *CleanUpConfig) WorkerCleanup() error

type K0sStatus

type K0sStatus struct {
	Version  string
	Pid      int
	PPid     int
	Role     string
	SysInit  string
	StubFile string
	Output   string
}

func GetPid

func GetPid() (status *K0sStatus, err error)

func (K0sStatus) GetK0sVersion

func (s K0sStatus) GetK0sVersion() (string, error)

func (K0sStatus) String

func (s K0sStatus) String()