From c2a037c7aaa901b609a7d9aacb6e494134067645 Mon Sep 17 00:00:00 2001 From: lydoan1199 Date: Tue, 28 Nov 2023 15:46:08 +0700 Subject: [PATCH] update readme and docker env --- README.md | 6 +++--- agentconfig_template | 2 +- cli.js | 2 +- docker/scripts/agent.sh | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 59d8e228..57475b60 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ agentName=My Agent email= apikey= serverUrl=https://analytics.katalon.com/ -teamId= +organizationId= ``` - Supported options: @@ -30,7 +30,7 @@ teamId= | email | The email of the Katalon account used to log into the Katalon TestOps. | | apikey | The API Key used to log into the Katalon TestOps. The API key can be generated and retrieved from [here](https://analytics.katalon.com/user/apikey). For more info read the [docs](https://docs.katalon.com/katalon-analytics/docs/ka-api-key.html#katalon-api-keys-usage). | | serverUrl | The Katalon TestOps' URL. | -| teamId | The ID of the Katalon TestOps team to integrate the Katalon Agent into. The agent is shared among members and projects within a team. | +| organizationId | The ID of the Katalon TestOps organization to integrate the Katalon Agent into. The agent is shared among members and projects within an organization that the agent linked to. | | uuid | The ID used to identify the agent. It is generated by the Katalon Agent on the first run and should not be specified manually or modified for any reason. | | Optional Option | Description | @@ -67,7 +67,7 @@ Note: On Linux and MacOS, you might need to add execute permission (`chmode u+x ## Generate the configuration file - The `agentconfig` file can be generated or updated by running `config` command with additional arguments. -- E.g. `node cli.js config --server-url https://analytics.katalon.com --username --apikey --teamid --agent-name my-agent` +- E.g. `node cli.js config --server-url https://analytics.katalon.com --username --apikey --organizationid --agent-name my-agent` - If an `agentconfig` has been created, the existing configuration will be overridden with the new value. - Show the usage of the `config` command with `-h` option. E.g. `node cli.js config -h`. diff --git a/agentconfig_template b/agentconfig_template index 92ec704b..ddd7d811 100644 --- a/agentconfig_template +++ b/agentconfig_template @@ -3,6 +3,6 @@ agentName= email= apikey= serverUrl= -teamId= +organizationId= keepFiles=false logLevel=INFO diff --git a/cli.js b/cli.js index 67bfb2e4..42120edf 100644 --- a/cli.js +++ b/cli.js @@ -68,7 +68,7 @@ program serverUrl: command.serverUrl, email: command.username, apikey: command.apikey, - teamId: command.organizationid, + organizationId: command.organizationid, agentName: command.agentName, configPath: command.config, proxy: command.proxy, diff --git a/docker/scripts/agent.sh b/docker/scripts/agent.sh index 82593865..31d1ff34 100755 --- a/docker/scripts/agent.sh +++ b/docker/scripts/agent.sh @@ -13,7 +13,7 @@ cd $KATALON_AGENT_DIR --server-url "$SERVER_URL" \ --username "$KATALON_USERNAME" \ --apikey "$KATALON_API_KEY" \ - --teamid "$TEAM_ID" \ + --organizationid "$ORGANIZATION_ID" \ --agent-name "$AGENT_NAME" \ --proxy "$PROXY" \ --log-level "$LOG_LEVEL" \