hzn-cli
Version:
Open Horizon CLI toolkit helps streamline the process of preparing node agents and perform tasks between orgs environments
259 lines (258 loc) • 6.57 kB
TypeScript
export declare const justRun: string[];
export declare const cliBypass: string[];
export declare const justRunCliOptional: any[];
export declare const promptForUpdate: string[];
export declare const customRun: string[];
export declare const runDirectly: string[];
export declare const loop: string[];
export declare const installTar: {
x86_64: string;
x64: string;
darwin: string;
arrch64: string;
arm64: string;
armv7l: string;
arm: string;
};
export declare const installPrompt: {
version: string;
};
export declare const supportPlatform: {
arm64: string;
amd64: string;
arm: string;
};
export declare const policyType: {
nodePolicy: string;
deploymentPolicy: string;
servicePolicy: string;
objectPolicy: string;
objectPattern: string;
};
export declare enum SetupEnvironment {
autoSetup = 0,
autoSetupCliOnly = 1,
autoSetupAnaxInContainer = 2,
autoSetupCliInContainer = 3,
autoSetupContainer = 4,
autoSetupAllInOne = 5,
autoUpdateConfigFiles = 6,
autoSetupOpenHorizonMesh = 7
}
export declare enum AutoCommand {
autoPublishService = 0,
autoPublishMMSService = 1,
autoAddDeploymentPolicy = 2,
autoUpdateNodePolicy = 3,
autoRegisterWithPolicy = 4,
autoRegisterWithPattern = 5,
autoUnregister = 6,
autoListPolicy = 7
}
export declare const keyMap: {
org: string;
service: string;
metaVars: string;
credential: string;
envVars: string;
};
export declare const HorizonTemplate: {
HZN_EXCHANGE_URL: string;
HZN_FSS_CSSURL: string;
HZN_DEVICE_ID: string;
HZN_NODE_ID: string;
HZN_AGBOT_URL: string;
HZN_SDO_SVC_URL: string;
HZN_MGMT_HUB_CERT_PATH: string;
HZN_AGENT_PORT: string;
};
export declare const HorizonKeyMap: {
HZN_CUSTOM_NODE_ID: string;
DEFAULT_ORG: string;
};
export declare const configTemplate: {
envHzn: {
envVars: {
SERVICE_NAME: string;
SERVICE_CONTAINER_NAME: string;
SERVICE_VERSION: string;
SERVICE_VERSION_RANGE_UPPER: string;
SERVICE_VERSION_RANGE_LOWER: string;
SERVICE_CONTAINER_CREDS: string;
MMS_SERVICE_NAME: string;
MMS_CONTAINER_NAME: string;
MMS_SERVICE_VERSION: string;
MMS_SERVICE_FALLBACK_VERSION: string;
MMS_CONTAINER_CREDS: string;
VOLUME_MOUNT: string;
MMS_SHARED_VOLUME: string;
MMS_OBJECT_TYPE: string;
MMS_OBJECT_ID: string;
MMS_OBJECT_FILE: string;
UPDATE_FILE_NAME: string;
SERVICE_CONSTRAINTS: string;
HZN_CSS: string;
EDGE_OWNER: string;
EDGE_DEPLOY: string;
};
credential: {
HZN_ORG_ID: string;
HZN_DEVICE_ID: string;
HZN_EXCHANGE_USER_AUTH: string;
HZN_EXCHANGE_URL: string;
HZN_FSS_CSSURL: string;
ANAX: string;
};
metaVars: {};
};
envLocal: {
YOUR_DOCKERHUB_ID: string;
DOCKER_REGISTRY: string;
DOCKER_TOKEN: string;
HZN_EXCHANGE_USER_AUTH: string;
HZN_EXCHANGE_URL: string;
HZN_FSS_CSSURL: string;
HZN_CUSTOM_NODE_ID: string;
DEFAULT_ORG: string;
ANAX: string;
ANAX_IN_CONTAINER: string;
MESH_API_KEY: string;
MESH_ENDPOINT: string;
PALMCTL_FILE_NAME: string;
USE_EDGE_CLUSTER_REGISTRY: boolean;
ENABLE_AUTO_UPGRADE_CRONJOB: boolean;
IMAGE_ON_EDGE_CLUSTER_REGISTRY: string;
EDGE_CLUSTER_REGISTRY_USERNAME: string;
EDGE_CLUSTER_REGISTRY_TOKEN: string;
EDGE_CLUSTER_STORAGE_CLASS: string;
AGENT_NAMESPACE: string;
KUBECONFIG: string;
};
envSupport: {
SUPPORTED_OS_APPEND: string;
SUPPORTED_LINUX_DISTRO_APPEND: string;
SUPPORTED_DEBIAN_VARIANTS_APPEND: string;
SUPPORTED_DEBIAN_VERSION_APPEND: string;
SUPPORTED_DEBIAN_ARCH_APPEND: string;
SUPPORTED_REDHAT_VARIANTS_APPEND: string;
SUPPORTED_REDHAT_VERSION_APPEND: string;
SUPPORTED_REDHAT_ARCH_APPEND: string;
};
};
export interface IAutoParam {
configFile: string;
object: Object;
k8s: string;
}
export interface IHznParam {
org: string;
configPath: string;
name: string;
objectType: string;
objectId: string;
objectFile: string;
mmsPattern: string;
action: string;
watch?: string;
filter?: string;
policy: IPolicy;
configFile: string;
image: string;
port: string;
type: string;
k8s: string;
compatibility: string;
}
export interface IPolicy {
envVar: string;
nodePolicyJson: string;
servicePolicyJson: string;
objectPolicyJson: string;
deploymentPolicyJson: string;
topLevelDeploymentPolicyJson: string;
}
export declare class RequiredService {
org: string;
url: string;
version: string;
versionRange: string;
arch: string;
constructor();
}
export declare class Container {
name: string;
image: string;
binds: string[];
privileged: boolean;
cap_add: string[];
devices: string[];
}
export declare class Deployment {
services: Container;
}
export declare class Service {
org: string;
url: string;
version: string;
label: string;
arch: string;
documentation: string;
public: boolean;
sharable: string;
requiredServices: RequiredService[];
userInput: any[];
deployment: Deployment;
source?: string;
display?: string;
owner?: string;
}
export declare const PlatformDistro: {
darwin: string;
freebsd: string;
linux: string;
win32: string;
ubuntu: string;
fedora: string;
centos: string;
rhel: string;
};
export declare const ICommand: {
'apt-get': (os: string) => "apt-get" | "dnf";
};
export declare const PalmCtl: {
rhel: {
x86_64: string;
x64: string;
};
darwin: {
i386: string;
arm64: string;
};
win32: {};
linux: {
x86_64: string;
x64: string;
};
};
export declare const K8sInstall: {
x86_64: {
install: string;
validate: string;
};
x64: {
install: string;
validate: string;
};
darwin: {
install: string;
validate: string;
};
arrch64: {
install: string;
validate: string;
};
arm64: {
install: string;
validate: string;
};
};