/
cli_constants.py
89 lines (76 loc) · 4.28 KB
/
cli_constants.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# coding: utf-8
# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
CLI_RC_FALLBACK_LOCATION = '~/.oci/cli-defaults'
CLI_RC_DEFAULT_LOCATION = '~/.oci/oci_cli_rc'
CLI_RC_CANNED_QUERIES_SECTION_NAME = 'OCI_CLI_CANNED_QUERIES'
CLI_RC_COMMAND_ALIASES_SECTION_NAME = 'OCI_CLI_COMMAND_ALIASES'
CLI_RC_PARAM_ALIASES_SECTION_NAME = 'OCI_CLI_PARAM_ALIASES'
CLI_RC_GENERIC_SETTINGS_SECTION_NAME = 'OCI_CLI_SETTINGS'
OCI_CLI_PROFILE_ENV_VAR = 'OCI_CLI_PROFILE'
CLI_RC_GENERIC_SETTINGS_DEFAULT_PROFILE_KEY = 'default_profile'
CLI_RC_GENERIC_SETTINGS_USE_CLICK_HELP = 'use_click_help'
OCI_CLI_AUTH_ENV_VAR = 'OCI_CLI_AUTH'
OCI_CLI_AUTH_INSTANCE_PRINCIPAL = 'instance_principal'
OCI_CLI_AUTH_RESOURCE_PRINCIPAL = 'resource_principal'
OCI_CLI_AUTH_INSTANCE_OBO_USER = 'instance_obo_user'
OCI_CLI_AUTH_API_KEY = 'api_key'
OCI_CLI_AUTH_SESSION_TOKEN = 'security_token'
OCI_CLI_AUTH_OKE_WORKLOAD_IDENTITY = 'oke_workload_identity'
OCI_CLI_UPST_TOKEN_MAX_TTL = '60'
OCI_CLI_UPST_TOKEN_MIN_TTL = '5'
OCI_KUBERNETES_SERVICE_ACCOUNT_TOKEN_PATH_ENV_VAR = 'OCI_KUBERNETES_SERVICE_ACCOUNT_TOKEN_PATH'
OCI_KUBERNETES_SERVICE_ACCOUNT_TOKEN_STRING_ENV_VAR = 'OCI_KUBERNETES_SERVICE_ACCOUNT_TOKEN_STRING'
OCI_CLI_REGION_ENV_VAR = 'OCI_CLI_REGION'
OCI_CLI_USER_ENV_VAR = 'OCI_CLI_USER'
OCI_CLI_FINGERPRINT_ENV_VAR = 'OCI_CLI_FINGERPRINT'
OCI_CLI_KEY_FILE_ENV_VAR = 'OCI_CLI_KEY_FILE'
OCI_CLI_KEY_CONTENT_ENV_VAR = 'OCI_CLI_KEY_CONTENT'
OCI_CLI_TENANCY_ENV_VAR = 'OCI_CLI_TENANCY'
OCI_CLI_PASSPHRASE_ENV_VAR = 'OCI_CLI_PASSPHRASE'
OCI_CLI_CONFIG_FILE_ENV_VAR = 'OCI_CLI_CONFIG_FILE'
OCI_CLI_RC_FILE_ENV_VAR = 'OCI_CLI_RC_FILE'
OCI_CLI_CERT_BUNDLE_ENV_VAR = 'OCI_CLI_CERT_BUNDLE'
OCI_CLI_DELEGATION_TOKEN_FILE_ENV_VAR = 'OCI_CLI_DELEGATION_TOKEN_FILE'
OCI_CLI_SECURITY_TOKEN_FILE_ENV_VAR = 'OCI_CLI_SECURITY_TOKEN_FILE'
OCI_CLI_ENDPOINT_ENV_VAR = 'OCI_CLI_ENDPOINT'
OCI_CLI_AUTO_PROMPT_ENV_VAR = 'OCI_CLI_AUTO_PROMPT'
OCI_CONFIG_ENV_VARS = {
OCI_CLI_USER_ENV_VAR: 'user',
OCI_CLI_FINGERPRINT_ENV_VAR: 'fingerprint',
OCI_CLI_KEY_FILE_ENV_VAR: 'key_file',
OCI_CLI_KEY_CONTENT_ENV_VAR: 'key_content',
OCI_CLI_TENANCY_ENV_VAR: 'tenancy',
OCI_CLI_PASSPHRASE_ENV_VAR: 'pass_phrase',
OCI_CLI_DELEGATION_TOKEN_FILE_ENV_VAR: 'delegation_token_file',
OCI_CLI_SECURITY_TOKEN_FILE_ENV_VAR: 'security_token_file'
}
OCI_CONFIG_REQUIRED_VARS = {
'user': OCI_CLI_USER_ENV_VAR,
'tenancy': OCI_CLI_TENANCY_ENV_VAR,
'fingerprint': OCI_CLI_FINGERPRINT_ENV_VAR,
'region': OCI_CLI_REGION_ENV_VAR
}
OCI_CLI_PARAM_TO_ENV_MAP = {
'region': OCI_CLI_REGION_ENV_VAR,
'endpoint': OCI_CLI_ENDPOINT_ENV_VAR,
'cert_bundle': OCI_CLI_CERT_BUNDLE_ENV_VAR,
'config_file': OCI_CLI_CONFIG_FILE_ENV_VAR,
}
MEBIBYTE = 1024 * 1024
CHANGE_LOG_URL = 'https://raw.githubusercontent.com/oracle/oci-cli/master/CHANGELOG.rst' # raw file used for requests
OCI_CLI_PYPI_URL = 'https://pypi.org/pypi/oci-cli/json'
# Documentations
OCI_CONFIG_DOCUMENTATION = 'https://docs.oracle.com/iaas/Content/API/SDKDocs/cliinstall.htm#configfile'
CLI_CONFIG_DOCUMENTATION = 'https://docs.oracle.com/iaas/Content/API/SDKDocs/cliconfigure.htm'
UPGRADING_CLI_DOCUMENTATION = 'https://docs.oracle.com/iaas/Content/API/SDKDocs/cliupgrading.htm'
INTERACTIVE_CLI_DOCUMENTATION = 'https://docs.oracle.com/iaas/Content/API/SDKDocs/cliusing_topic-Using_Interactive_Mode.htm'
INPUT_OUTPUT_DOCUMENTATION = 'https://docs.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#Managing_CLI_Input_and_Output'
TROUBLESHOOTING_DOCUMENTATION = 'https://docs.oracle.com/iaas/Content/API/SDKDocs/clitroubleshooting.htm'
SERVICE_ERROR_DOCUMENTATION = 'https://docs.oracle.com/iaas/Content/API/References/apierrors.htm'
GITHUB_CHANGELOG = 'https://github.com/oracle/oci-cli/blob/master/CHANGELOG.rst'
INTERACTIVE_CLI_SUGGESTION_MESSAGE = 'For OCI CLI commands and parameters suggestion, auto completion and ' \
'other useful features, try the Interactive mode by typing `oci -i`.'
NO_SUCH_COMMAND_ERROR_STRING = "{}\n\nError: No such command {}"
SSE_RESPONSE_HEADER_VALUE = 'text/event-stream'
READ_TIMEOUT_SSE = 60