Documentation
¶
Index ¶
- Constants
- Variables
- func DeleteConfigValue(cfg *ini.File, path, sectionName, keyName string) error
- func DeleteCredentials(cfg *ini.File, path, sectionName string) error
- func DeleteProfile(cfg *ini.File, path, profileName string) error
- func DeleteProfileConfigValue(cfg *ini.File, path, profileName, keyName string) error
- func ExpandConfigPaths() []string
- func GetActiveProfileName(cfg *ini.File, flagOverride string) string
- func GetConfigValue(cfg *ini.File, sectionName, keyName string) (string, error)
- func GetCustomHeaders(cfg *ini.File, sectionName string) map[string]string
- func GetProfileConfigValue(cfg *ini.File, profileName, keyName string) string
- func GetProfileCredentials(cfg *ini.File, profileName string) (endpoint, appKey, appSecret, consumerKey string, err error)
- func GetProfileCustomHeaders(cfg *ini.File, profileName string) map[string]string
- func GetProfileSection(cfg *ini.File, profileName string) (*ini.Section, error)
- func IsDefaultProfile(name string) bool
- func IsProfileMode(cfg *ini.File, flagOverride string) bool
- func ListProfiles(cfg *ini.File) []string
- func LoadINI() (*ini.File, string)
- func ProfileSectionName(profileName string) string
- func SetActiveProfile(cfg *ini.File, path, profileName string) error
- func SetConfigValue(cfg *ini.File, path, sectionName, keyName, value string) error
- func SetProfileConfigValue(cfg *ini.File, path, profileName, keyName, value string) error
Constants ¶
const DefaultProfileName = "default"
DefaultProfileName is the reserved name for the legacy/default configuration. It does not map to a [profile:default] section — instead it represents the standard go-ovh configuration from [default] + [ovh-<endpoint>] sections.
const HeaderKeyPrefix = "header."
HeaderKeyPrefix prefixes INI keys used to store custom HTTP headers (e.g. "header.X-Routing-Key = abc123") in a profile or endpoint section.
Variables ¶
var ( ConfigPaths = []string{ "/etc/ovh.conf", "~/.ovh.conf", "./ovh.conf", } ConfigurableFields = map[string]string{ "endpoint": "default", "default_cloud_project": "ovh-cli", } )
var ActiveProfileOverride string
ActiveProfileOverride is set from the --profile CLI flag by the root command's PersistentPreRun. It allows GetConfigValue to respect the --profile flag without the config package needing to import the flags package.
var CredentialKeys = []string{"application_key", "application_secret", "consumer_key"}
CredentialKeys are the INI keys holding OVHcloud API credentials.
Functions ¶
func DeleteConfigValue ¶ added in v0.14.0
DeleteConfigValue removes a key from the given section. If sectionName is empty, it is resolved via ConfigurableFields like SetConfigValue does.
func DeleteCredentials ¶ added in v0.13.0
DeleteCredentials removes the API credential keys (application_key, application_secret, consumer_key)
func DeleteProfile ¶ added in v0.10.0
DeleteProfile removes a profile section from the config. If the deleted profile was the active one, the "profile" key is removed from [default] (falling back to legacy mode).
func DeleteProfileConfigValue ¶ added in v0.14.0
DeleteProfileConfigValue removes a key from a profile section.
func ExpandConfigPaths ¶
func ExpandConfigPaths() []string
configPaths returns configPaths, with ~/ prefix expanded.
func GetActiveProfileName ¶ added in v0.10.0
GetActiveProfileName returns the active profile name by checking (in order): 1. The flagOverride parameter (from --profile CLI flag) 2. The OVH_PROFILE environment variable 3. The "profile" key in the [default] INI section Returns "" if no profile is configured (legacy mode).
func GetConfigValue ¶
func GetCustomHeaders ¶ added in v0.14.0
GetCustomHeaders returns the custom HTTP headers configured in the given section (an endpoint-named legacy section), stored as "header.<Name>" INI keys. Returns an empty map if cfg is nil, sectionName is empty, or the section has no such keys.
func GetProfileConfigValue ¶ added in v0.10.0
GetProfileConfigValue reads a configuration value from a profile section.
func GetProfileCredentials ¶ added in v0.10.0
func GetProfileCredentials(cfg *ini.File, profileName string) (endpoint, appKey, appSecret, consumerKey string, err error)
GetProfileCredentials reads OVHcloud API credentials from a profile section. Environment variables (OVH_ENDPOINT, OVH_APPLICATION_KEY, etc.) take precedence.
func GetProfileCustomHeaders ¶ added in v0.14.0
GetProfileCustomHeaders returns the custom HTTP headers configured for the given profile, stored as "header.<Name>" INI keys in its profile section.
func GetProfileSection ¶ added in v0.10.0
GetProfileSection returns the [profile:<name>] INI section for the given profile.
func IsDefaultProfile ¶ added in v0.10.0
IsDefaultProfile returns true if the given name is the reserved default profile.
func IsProfileMode ¶ added in v0.10.0
IsProfileMode returns true if a profile is active (either from flag, env, or config).
func ListProfiles ¶ added in v0.10.0
ListProfiles returns the names of all profiles found in the INI config.
func LoadINI ¶
loadINI builds a ini.File from the configuration paths provided in configPaths. It's a helper for loadConfig.
func ProfileSectionName ¶ added in v0.13.0
func SetActiveProfile ¶ added in v0.10.0
SetActiveProfile sets the active profile in the [default] section.
func SetConfigValue ¶
Types ¶
This section is empty.
Source Files