Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

https://gitlab.com/akraino-pcei-onap-cds/equinix-pcei-poc/-/tree/main/postman-collections

PCEI Release 6 APIs

In Release 6 PCEI adds one more API - Ansible Execution API.

Ansible Execution API

Code Block
{
	"commonHeader": {
		"originatorId": "System",
		"requestId": "123456",
		"subRequestId": "1234-12234"
	},
	"actionIdentifiers": {
		"blueprintName": "ansible-playbook-executor",
		"blueprintVersion": "1.0.0",
		"actionName": "execute-ansible-playbook",
		"mode": "sync"
	},
	"payload": {
		"execute-ansible-playbook-request": {
			"implementation": {
				"timeout": 3000
			},
			"cds-py-exec-pod-ip": "USER_INPUT_PY_EXECUTOR_IP",
			"py-exec-grcp-timeout": "USER_INPUT_CDS_PY_EXEC_GRPC_TIMEOUT_INTGER_MILLI_SECOND",
			"workflow-name": "execute-ansible-playbook",
			"skip-input-params-keys-validation": ["ansible-cli-env-variables"],
			"input-params": {
				"ssh-key-git-repository": {
					"git-user": "USER_INPUT_GIT_USERNAME",
					"git-access-token": "USER_INPUT_GIT_ACCESS_TOKEN",
					"git-url": "USER_INPUT_GIT_URL",
					"git-branch": "USER_INPUT_GIT_BRANCH",
					"git-download-folder": "/opt/app/onap/blueprints",
					"git-project-folder": "USER_INPUT_GIT_PROJECT_FOLDER",
					"ssh-key-file-name": "USER_INPUT_KEY_FILE"
				},
				"ansible-scripts-git-repository": {
					"git-user": "USER_INPUT_GIT_USERNAME",
					"git-access-token": "USER_INPUT_GIT_ACCESS_TOKEN",
					"git-url": "USER_INPUT_GIT_URL",
					"git-branch": "USER_INPUT_GIT_BRANCH",
					"git-download-folder": "/opt/app/onap/blueprints",
					"git-project-folder": "USER_INPUT_GIT_PROJECT_FOLDER",
					"ansible-scripts-folder": "USER_INPUT_ANSIBLE_SCRIPT_FOLDER",
					"ansible-main-yaml-file-name": "USER_INPUT_ANSIBLE_YAML_FILE_NAME"
				},
				"ansible-cli-env-variables": {
					"target_ip": "USER_INPUT_IP_ADDRESS",
					"target_host_user": "USER_INPUT_LOGIN_USERNAME",
					"bgp_edge_address": "USER_INPUT_BGP_EDGE_ADDRESS",
					"localhost_kud_config_realtive_download_folder": ".kube",
					"git_url": "USER_INPUT_GIT_URL_WITHOUT_HTTPS",
					"git_branch": "USER_INPUT_GIT_BRANCH",
					"remote_host_relative_clone_folder": "USER_INPUT_CLONE_TARGET_DIR",
					"git_user": "USER_INPUT_GIT_USERNAME",
					"git_accesstoken": "USER_INPUT_GIT_ACCESS_TOKEN",
					"git_user_email": "USER_INPUT_GIT_EMAIL_ID",
					"customer_id": 	"USER_INPUT_CUSTOMER_ID"
				}
			}
		}
	}
}