platform

Documentation

Overview

* Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors. All rights reserved. * SPDX-License-Identifier: Apache-2.0

Index

• func AddGroup(ctx context.Context, groupName string) error
• func AddUser(ctx context.Context, username, fullname, password string) error
• func AssociateUserToGroup(ctx context.Context, username, groupName string) error
• func BootTime() (bootime time.Time, err error)
• func ConvertError(err error) error
• func ConvertUserGroupError(err error) error
• func DefineSudoCommand(args ...string)
• func DefineUser(ctx context.Context, user *user.User, password string) (err error)
• func DeleteUser(ctx context.Context, user *user.User) (err error)
• func DissociateUserFromGroup(ctx context.Context, username, groupName string) error
• func HasGroup(groupName string) (found bool, err error)
• func HasUser(username string) (found bool, err error)
• func Hostname() (string, error)
• func IsWindows() bool
• func LineSeparator() string
• func NodeName() (nodename string, err error)
• func PlatformInformation() (information string, err error)
• func RemoveGroup(ctx context.Context, groupName string) error
• func RemoveUser(ctx context.Context, username string) error
• func SystemInformation() (information string, err error)
• func Uname() (string, error)
• func UnixLineSeparator() string
• func UpTime() (uptime time.Duration, err error)
• type RAM
  • func GetRAM() (ram RAM, err error)
• type VirtualMemory
  • func (m *VirtualMemory) GetAvailable() uint64
  • func (m *VirtualMemory) GetFree() uint64
  • func (m *VirtualMemory) GetTotal() uint64
  • func (m *VirtualMemory) GetUsed() uint64
  • func (m *VirtualMemory) GetUsedPercent() float64

Functions

func AddGroup

func AddGroup(ctx context.Context, groupName string) error

AddGroup creates a group if not already existing.

func AddUser

func AddUser(ctx context.Context, username, fullname, password string) error

AddUser adds a new user to the platform

func AssociateUserToGroup

func AssociateUserToGroup(ctx context.Context, username, groupName string) error

AssociateUserToGroup adds a user to a group.

func BootTime

func BootTime() (bootime time.Time, err error)

BootTime returns system uptime.

func ConvertError

func ConvertError(err error) error

ConvertError converts a platform error into a commonerrors

func ConvertUserGroupError

func ConvertUserGroupError(err error) error

ConvertUserGroupError converts errors related to users in common errors.

func DefineSudoCommand

func DefineSudoCommand(args ...string)

DefineSudoCommand defines the command to run to be `root` or a user with enough privileges to manage accounts. e.g.

• args="sudo" to run commands as `root`
• args="su", "tom" if `tom` has enough privileges to run the command
• args="gosu", "tom" if `tom` has enough privileges to run the command in a container and `gosu` is installed

func DefineUser

func DefineUser(ctx context.Context, user *user.User, password string) (err error)

DefineUser adds a new user to the platform

func DeleteUser

func DeleteUser(ctx context.Context, user *user.User) (err error)

DeleteUser removes a user from the platform when the user is specified using a `user.User` structure.

func DissociateUserFromGroup

func DissociateUserFromGroup(ctx context.Context, username, groupName string) error

DissociateUserFromGroup removes a user from a group.

func HasGroup

func HasGroup(groupName string) (found bool, err error)

HasGroup checks whether a group exists

func HasUser

func HasUser(username string) (found bool, err error)

HasUser checks whether a user exists

func Hostname

func Hostname() (string, error)

Hostname returns the hostname.

func IsWindows

func IsWindows() bool

IsWindows checks whether we are running on Windows or not.

func LineSeparator

func LineSeparator() string

LineSeparator returns the line separator.

func NodeName

func NodeName() (nodename string, err error)

NodeName returns the system node name (equivalent to uname -n).

func PlatformInformation

func PlatformInformation() (information string, err error)

PlatformInformation returns the platform information (equivalent to uname -s).

func RemoveGroup

func RemoveGroup(ctx context.Context, groupName string) error

RemoveGroup removes a group from the platform

func RemoveUser

func RemoveUser(ctx context.Context, username string) error

RemoveUser removes a user from the platform when only the username is known.

func SystemInformation

func SystemInformation() (information string, err error)

SystemInformation returns the system information (equivalent to uname -a)

func Uname

func Uname() (string, error)

func UnixLineSeparator

func UnixLineSeparator() string

UnixLineSeparator returns the line separator on Unix platform.

func UpTime

func UpTime() (uptime time.Duration, err error)

UpTime returns system uptime.

Types

type RAM

type RAM interface {
	// GetTotal returns total amount of RAM on this system
	GetTotal() uint64
	// GetAvailable returns RAM available for programs to allocate
	GetAvailable() uint64
	// GetUsed returns RAM used by programs
	GetUsed() uint64
	// GetUsedPercent returns Percentage of RAM used by programs
	GetUsedPercent() float64
	// GetFree returns kernel's notion of free memory
	GetFree() uint64
}

func GetRAM

func GetRAM() (ram RAM, err error)

type VirtualMemory

type VirtualMemory struct {
	Total       uint64
	Available   uint64
	Used        uint64
	UsedPercent float64
	Free        uint64
}

func (*VirtualMemory) GetAvailable

func (m *VirtualMemory) GetAvailable() uint64

func (*VirtualMemory) GetFree

func (m *VirtualMemory) GetFree() uint64

func (*VirtualMemory) GetTotal

func (m *VirtualMemory) GetTotal() uint64

func (*VirtualMemory) GetUsed

func (m *VirtualMemory) GetUsed() uint64

func (*VirtualMemory) GetUsedPercent

func (m *VirtualMemory) GetUsedPercent() float64