Documentation

Overview

    Package util implements various utility functions used in both testing and implementation of Kubernetes. Package util may not depend on any other package in the Kubernetes package tree.

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func AllPtrFieldsNil

    func AllPtrFieldsNil(obj interface{}) bool

      Tests whether all pointer fields in a struct are nil. This is useful when, for example, an API struct is handled by plugins which need to distinguish "no plugin accepted this spec" from "this spec is empty".

      This function is only valid for structs and pointers to structs. Any other type will cause a panic. Passing a typed nil pointer will return true.

      func CompileRegexps

      func CompileRegexps(regexpStrings []string) ([]*regexp.Regexp, error)

        Takes a list of strings and compiles them into a list of regular expressions

        func ExecuteTemplate

        func ExecuteTemplate(w io.Writer, templateText string, data interface{}) error

          ExecuteTemplate executes templateText with data and output written to w.

          func ExecuteTemplateToString

          func ExecuteTemplateToString(templateText string, data interface{}) (string, error)

          func FileExists

          func FileExists(filename string) (bool, error)

          func Int32Ptr

          func Int32Ptr(i int32) *int32

            Int32Ptr returns a pointer to an int32

            func Int32PtrDerefOr

            func Int32PtrDerefOr(ptr *int32, def int32) int32

              Int32PtrDerefOr dereference the int32 ptr and returns it i not nil, else returns def.

              func IntPtr

              func IntPtr(i int) *int

                IntPtr returns a pointer to an int

                func IntPtrDerefOr

                func IntPtrDerefOr(ptr *int, def int) int

                  IntPtrDerefOr dereference the int ptr and returns it i not nil, else returns def.

                  func ReadDirNoStat

                  func ReadDirNoStat(dirname string) ([]string, error)

                    ReadDirNoStat returns a string of files/directories contained in dirname without calling lstat on them.

                    func Umask

                    func Umask(mask int) (old int, err error)

                    func UsingSystemdInitSystem

                    func UsingSystemdInitSystem() bool

                      Detects if using systemd as the init system Please note that simply reading /proc/1/cmdline can be misleading because some installation of various init programs can automatically make /sbin/init a symlink or even a renamed version of their main program. TODO(dchen1107): realiably detects the init system using on the system: systemd, upstart, initd, etc.

                      Types

                      This section is empty.

                      Directories

                      Path Synopsis
                      Package bandwidth provides utilities for bandwidth shaping
                      Package bandwidth provides utilities for bandwidth shaping
                      Package config provides utility objects for decoupling sources of configuration and the actual configuration state.
                      Package config provides utility objects for decoupling sources of configuration and the actual configuration state.
                      Package dbus provides an injectable interface and implementations for D-Bus communication
                      Package dbus provides an injectable interface and implementations for D-Bus communication
                      Package errors only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package errors only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package exec provides an injectable interface and implementations for running commands.
                      Package exec provides an injectable interface and implementations for running commands.
                      Package framer only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package framer only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package goroutinemap implements a data structure for managing go routines by name.
                      Package goroutinemap implements a data structure for managing go routines by name.
                      exponentialbackoff
                      Package exponentialbackoff contains logic for implementing exponential backoff for GoRoutineMap and NestedPendingOperations.
                      Package exponentialbackoff contains logic for implementing exponential backoff for GoRoutineMap and NestedPendingOperations.
                      Package intstr only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package intstr only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package ipconfig provides an interface and implementations for running Windows ipconfig commands.
                      Package ipconfig provides an interface and implementations for running Windows ipconfig commands.
                      Package iptables provides an interface and implementations for running iptables commands.
                      Package iptables provides an interface and implementations for running iptables commands.
                      Package json only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package json only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package labels provides utilities to work with Kubernetes labels.
                      Package labels provides utilities to work with Kubernetes labels.
                      Package limitwriter provides a writer that only allows a certain number of bytes to be written.
                      Package limitwriter provides a writer that only allows a certain number of bytes to be written.
                      Package maps has common methods for dealing with common map types.
                      Package maps has common methods for dealing with common map types.
                      Package mount defines an interface to mounting filesystems.
                      Package mount defines an interface to mounting filesystems.
                      net
                      Package net only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package net only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package netsh provides an interface and implementations for running Windows netsh commands.
                      Package netsh provides an interface and implementations for running Windows netsh commands.
                      Package oom implements utility functions relating to out of memory management.
                      Package oom implements utility functions relating to out of memory management.
                      Package procfs implements utility functions relating to the /proc mount.
                      Package procfs implements utility functions relating to the /proc mount.
                      Package rand needed for godep.
                      Package rand needed for godep.
                      Package runtime only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package runtime only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package selinux contains wrapper functions for the libcontainer SELinux package.
                      Package selinux contains wrapper functions for the libcontainer SELinux package.
                      Package sets only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package sets only exists until heapster rebases TODO genericapiserver remove this empty package.
                      types
                      Package sets only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package sets only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package slice provides utility methods for common operations on slices.
                      Package slice provides utility methods for common operations on slices.
                      package taints implements uitilites for working with taints
                      package taints implements uitilites for working with taints
                      Package tolerations provides utilities to work with pod spec tolerations.
                      Package tolerations provides utilities to work with pod spec tolerations.
                      uuid contains uuid generation helpers.
                      uuid contains uuid generation helpers.
                      Package validation only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package validation only exists until heapster rebases TODO genericapiserver remove this empty package.
                      field
                      Package field only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package field only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package version provides utilities for version number comparisons
                      Package version provides utilities for version number comparisons
                      Package wait only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package wait only exists until heapster rebases TODO genericapiserver remove this empty package.
                      workqueue
                      Package yaml only exists until heapster rebases TODO genericapiserver remove this empty package.
                      Package yaml only exists until heapster rebases TODO genericapiserver remove this empty package.