dcloud is a tool to control, monitor and trigger your deployments to DEITY Falcon Cloud.
In order to use it, install it globally with:
npm i -g dcloud- fixed issues with redirects uploading
- added possibility to enable/disable SEO indexing for particular environment details here
- added possibility to enable/disable maintenance mode of environments details here
- added possibility to display logs as list details here
- added possibility to add/remove webhooks that will be called after deployment details here
-
added possibility to configure access to environments only for users who have DeityCloud account details here
-
added possibility to configure access to environments only for predefined IP addresses details here
- added possibility to configure branches which will be build automatically details here
- adjusted all dependencies to work with the newest node.js versions
- added possiblity to run build for particular commit details here
- changed authentication to use the new configuration
- added possibility to select user role when sending invitation details here
- Fixed issue during rendering logs when using
log:watchcommand
- Improved messaging of domain verification process
- Added wizard for domain creation and SSL certificate validation details here
- Added
--moduleoption to search logs module field details here
- fixed issue with loading environment variables from file
- Added
--data-file, -dflag that gives the possibility to load the value of environment variable from a file so it doesn't stay in the bash history details here - Added
--base64, -eflag that encodes the value of passed environment variable as base64 before sending to the api details here - Added
--from-file, -fflag that gives the possibility to set multiple environment variables at once (by loading them from specified file) details here
- Fixed issues with table rendering during log streaming
- Added support for external domains details here
- Added information about outdated builds
- Improved handling of currency configuration for DPSG
- Fixed warning about missing dependencies
- Added
payments:customer-map:addcommand for adding mappings between shop customer and psp customer details here
- Fixed issues with displaying special characters in tables
- Added
--pathoption to purge cdn domain - details here - Added command
dcloud env:cache:flush <env>that flushes the environment cache - details here
- The command
dcloud project:current:setcan now be executed without the organization and project flag. When doing so, you can select the project using an interactive prompt.
- Added command to delete a payment profile
- Added command to update a payment profile
- Renamed
payments:envcommands topayments:profile. - Removed the
payments:regioncommands. This functionality is replaced by region prompts on most payments commands. - Added command to auto-generate/sync the payments profiles to the project environment
payments:profile:sync. - Added command to update a payment method
- added optional
--phraseparameter to filter logs by passed search phrase.
- Added automatic redirect to the login page if authentication is no longer valid
- Added information about environment location to
dcloud envcommand - Improved display of environment details
- Fixed an issue that presented the countries list when configuring the currencies of a payment provider.
- Restricted the input for
Merchant's store countrywhen configuring the Humm payment provider.
- Added commands to set/get the DPSG region - details here
- Added ability to set minimum and maximum amounts when configuring payment methods - details here
- Fixed issue with user:invite command
- Fixed an issue (typo) in the applyToken (DPSG) command, that resulted in environment variables not being set properly for that command
- Added "environment apply" command for DPSG, to configure the DPSG environment variables on the Deity Cloud Environment - details here
- Added DPSG commands - details here
- Added logs filtering (by application name) - details here
- Added logs stream filtering (by application name) - details here
- Added CDN purge command - details here
- Added CDN purge status progress command - details here
- Added upload CSV file with redirects command - details here
- Added delete all redirects command - details here
- Updated internal dependencies to improve security
- Added possibility to select version of FalconPlatform for particular environment - details here
- Added logs filtering (by date range, and severity) - details here
- Added log output formatting - it's now possible to print log entries as JSON - details here
- Added possibility to fetch single log item by its id - details here
List your current builds.
dcloud build:listOptions
-
-l <limit>Limit the results -
-p <page>Which page of results to show
Example: show 30 results
dcloud build:list -l 30Get information on a build.
dcloud build [id]Options
-
-wWatch a build (if it's not finished) -
-oShow build output to the console
Example: Watch the build with id 20
dcloud build 20 -wBy default DeityCloud service runs builds for every single push to the repository. You can change that behavior (to avoid cluttering the build list with unnecessary builds and use less storage) so builds are triggered only for the particular branches (you will still be able to create a build from particular branch or commit).
In order to configure a branch to be built automatically use the following command:
dcloud build:branch:add [branch-name]Options
N/A
Remove branch name from the list of automatically built branches after code push
dcloud build:branch:remove [branch-name]Options
N/A
List all branch names that will be built automatically after code push
dcloud build:branch:listOptions
N/A
Run a new build for particular commit. As parameter you can pass any value that can be passed to git checkout command in your repository
dcloud build:commit [commit-sha|branch-name|tag-name]Example: Run build for commit 0d88dccc
dcloud build:commit 0d88dcccExample: Run build for main branch
dcloud build:commit mainExample: Run build for v1.0 tag
dcloud build:commit v1.0List your deployments
dcloud deployment:listOptions
-
-l <limit>Limit the results -
-p <page>Which page of results to show
Get information on a deployment.
dcloud deployment [id]Options
-
-wWatch a deployment (if it's not finished) -
-oShow deployment output to the console
Deploy a build
dcloud deployment:run [buildId] [environmentName]Options
-
-yAuto-confirm the deployment process. Useful if you're not deploying manually.
Example: Deploy build 20 to the development environment
dcloud deployment:run 20 developmentList all available environments
dcloud env:listOptions
N/A
Maintenance mode allows you to present a "we're under maintenance" view and do not pass any requests to the application. This allows to perform maintenance of 3rd party systems without disruption from the PWA/Middleware users.
When maintenance mode is enabled all the request are routed to the maintenance.html view which should be placed in public folder of your frontend application.
dcloud env:maintenance:enable [env]Options
N/A
dcloud env:maintenance:disable [env]Options
N/A
NOTE: to be sure that the values are correctly read from your terminal surround variable-value with double quotes, for example:
Get info on a specific environment
dcloud env <env>Options
N/A
Get deployments for an environment
dcloud env:deployments <env>Options
-
-l <limit>Limit the results -
-p <page>Which page of results to show
Set a variable on an environment (this doesn't send the variable to the application immediately. In order to do so you have to either run a deployment or apply saved variables)
dcloud env:var:set <env> <name> [value]Options
-
-s, --secretmarks variable as secret - it's full value cannot be read (will be masked when displaying) -
-d, --data-file <filePath>Path to the file containing environment variable value -
-e, --base64Encode the variable value as base64 string before sending it -
-f, --from-file <filePath>Set multiple environment variables from a file with one command (see information about file format below)
NOTE: to be sure that the values are correctly read from your terminal surround variable-value with double quotes, for example:
dcloud project:var:set BUILD_TOKEN "abcdefg123"Format of the file passed to -f (--from-file) option is the following:
FOO=variable value
# comment - will be ignored
BAR=126
BAZ=full string will be taken as value
NOTE: Everything after first
=sign will be passed as variable value - including whitespaces, quotes etc. It means that if you put a string in quotes then these quotes will be included as value (which usually is not intended).
Applies previously set environment variables to the actual environment. Once applied the application in that environment will be restarted and after restart will have access to the applied environment variables.
dcloud env:var:apply <env>Options
N/A
Assign a domain to an environment
dcloud env:domain:assign <env> [domainName]Options
N/A
Get the configuration of the domain assigned to the environment
dcloud env:domain <env>Options
N/A
Un-assign a domain from an environment
dcloud env:domain:unassign <env> [domainName]Options
N/A
Upload redirects rules
dcloud env:redirects:upload <env> <absolute path to file>CSV File format example:
old_url,new_url
old_url2,new_url2
old_url3,new_url3
Options
N/A
Delete redirects
dcloud env:redirects:delete <env>Options
N/A
Flush environment cache
dcloud env:cache:flush <env>Options
N/A
List available FalconPlatform versions
dcloud env:platform-version:listChange FalconPlatform version for environment (deploy FalconServer in selected version to selected environment)
dcloud env:platform-version:set <env> <version>You can set up environment to be avaialble only for people who have DeityCloud account. That way nobody from outside your team will not be able to see the environment. The access is configurable per environment - you can specify which accounts can see partiular environment.
Note: after this action is performed you need to call
env:var:applycommand to synchronize the environment.
dcloud env:auth:enable <environment>Note: after this action is performed you need to call
env:var:applycommand to synchronize the environment.
dcloud env:auth:disable <environment>dcloud env:auth:list <environment>dcloud env:auth:add <environment> <email>dcloud env:auth:remove <environment> <email>You can set up environment to be avaialble only when viewer IP is on allowed to view it. The IP access is configurable per environment - you can specify which IPs can see partiular environment.
Note: after this action is performed you need to call
env:var:applycommand to synchronize the environment.
dcloud env:ip:allowlist:enable <environment>Note: after this action is performed you need to call
env:var:applycommand to synchronize the environment.
dcloud env:ip:allowlist:disable <environment>dcloud env:ip:allowlist:list <environment>dcloud env:ip:allowlist:add <environment> <IP> <name>The name parameter is optional - it's used as label for IP so it's easy to identify it
dcloud env:ip:allowlist:remove <environment> <IP>NOTE: Currently, webhooks will be called when deployment to particular environment finishes with sucessfull status.
dcloud env:webhooks:add <env> <name> <url>-
nameis a unique name of webhook so you can identify its purpose -
urlis full url that should be called
Example:
dcloud env:webhooks:add production run-tests https://my-test-service/run-tests
dcloud env:webhooks:list <env>In order to remove webhook call the command below and you'll be presented with list of webhooks that you can select to be removed.
dcloud env:webhooks:remove <env>By default each environment has indexing enabled. You can however block the indexing robots by toggling this feature and DeityCloud infrastructure will override robots.txt file in your project with the one with the following content:
User-agent: *
Disallow: /
dcloud env:indexing:enable <env>dcloud env:indexing:disable <env>NOTE: robots.txt file by default is cached for 15 minutes by CDN so make sure to wait 15 minutes after configuration changes.
List all the domains created in the project
dcloud domain:listCreates domain (managed by DeityCloud infrastructure or externally) and its configuration but doesn't apply it to an environment, so the domain is not used yet.
You can create many domains in the scope of the project and then assign particular domain to particular environment.
dcloud domain:create <domain>Options
-
--externalmarks domain as external - if you manage the domain by yourself (e.g. on your CloudFlare account then use this flag)
dcloud domain:create --external my-custom-domain.comRemoves the domain from project. Please note that the domain must not be assigned to any environment in order to remove it.
dcloud domain:remove <domain>Options
N/A
Purge CDN cache for a domain
dcloud domain:purge-cdn-cache <domain>Options
-
-p, --path <path>Purges at CDN the particular path at your domain: example.com/YOUR_PATH
dcloud domain:purge-cdn-cache example.io -p robot.txtGet status of purge CDN process for a domain
dcloud domain:purge-cdn-status <purgeID>Options
N/A
After cration of a domain under your project you need to validate its ownership in order to be able to assign the domain to an environment and create SSL certificate for it.
To start the vadliation run:
dcloud domain:validate <domain>Options
N/A
The process will guide you through the validation of both domain ownership and SSL certificate. Once these steps are done you'll be able to assing the domain to your environment.
Get the list of latest logs per environment
dcloud log:list [options] [environment]Options
-
-l <limit>Limit the results -
-p <page>Which page of results to show -
--from <date>Date from (see below) -
--to <date>Date to (see below) -
--span <span>Date span (see below) -
-–severity <severity>Log item severity, (you join them with comma to use multiple at once). Available values:TRACE,DEBUG,INFO,WARNING,ERROR,CRITICAL -
-–app <value>Log item application name, (you join them with comma to use multiple at once). Available values:nginx,FalconServer,FalconClient -
-–phrase <value>Log item filtered by passed search phrase. -
-–module <value>Log item filtered by passed module. -
-o, --output <format>Output format of the logs, by default it usestableso the logs are printed in the formatted table but you can also use:-
jsonorjson-formattedto get the items in JSON format -
listto get the items as plantext list
-
You can use one of the following:
-
ISO date format, e.g.
2021-02-01T11:31:17.003Z -
YYYY/MM/DD or YYYY-MM-DD, e.g.
2021/02/01or2021/02/01 -
YYYY/MM/DD HH:MM:SS(Z) e.g.
2021/02/01 11:31:17or2021/02/01 11:31:17Z
Date span option allows you to get log items from particular time span. You can combine that also with --from or --to to get the logs from exact time you're interested in
Available span markers:
-
d- days -
h- hours -
m- minutes -
s- seconds
Examples:
-
get logs from last 5 minutes:
--span=5m -
get logs from 3 minutes before 2021/02/01 10:05:00 (up to 2021/02/01 10:05:00):
--to='2021/02/01 10:05:00' --span=3m -
get logs from 2021/02/01 10:05:00 to 2 minutes after that time:
--from='2021/02/01 10:05:00' --span=2m
Get log entry by its id
dcloud log:item [environment] [itemId]Options
-
-o, --output <format>Output format of the logs, by default it usestableso the logs are printed in the formatted table but you can also usejsonorjson-formattedto get the items in JSON format
Get the log output for given environment
dcloud log:watch [environment]Options
-
-–severity <severity>Log item severity, (you join them with comma to use multiple at once). Available values:TRACE,DEBUG,INFO,WARNING,ERROR,CRITICAL -
-–app <value>Log item application name, (you join them with comma to use multiple at once). Available values:nginx,FalconServer,FalconClient -
-–phrase <value>Log item filtered by passed search phrase.
Get a list of your current/active repositories
dcloud repoOptions
-
-iShow setup instructions for each repository
Get your project information
dcloud project <name>Options
N/A
Get a list of your projects
dcloud project:listOptions
-
-l <limit>Limit the results -
-p <page>Which page of results to show
Get the current project
dcloud project:currentOptions
N/A
Set a project as current
dcloud project:current:set [organization] [projectName]Options
N/A
List your variables
dcloud project:var:listOptions
N/A
NOTE: variables listed here for security reasons are masked and you cannot read the exact value
List your variables
dcloud project:var:set <variable-name> <variable-value>Options
N/A
NOTE: to be sure that the values are correctly read from your terminal surround variable-value with double quotes, for example:
dcloud project:var:set BUILD_TOKEN "abcdefg123"WARNING: This is deprecated, please use Login with Token to log in. Existing users will be prompted to migrate to using a token for logging in.
Logs into DEITY Falcon Cloud using credentials. If credentials aren't passed you will be prompted to add them.
dcloud login [email] [password]Options
N/A
Logs the current user out
dcloud logoutOptions
N/A
Get the current logged in user
dcloud whoamiOptions
N/A
Create and send invitation
dcloud user:invite <email> <name>Running this command will show you picker that gives the possibility to select a role which invited user will get assigned
Example: show 30 results
dcloud user:invite john@example.com "John Smith"Options
N/A
dcloud payments:provider:list:alldcloud payments:method:list:alldcloud payments:provider:listdcloud payments:method:listdcloud payments:provider:configuredcloud payments:method:configuredcloud payments:profile:syncdcloud payments:profile:createdcloud payments:profile:updatedcloud payments:profile:deletedcloud payments:profile:infodcloud payments:customer-map:add --organization <my-org> --project <my-project> --environment <my-env> --provider <provider-name> --region <dpsg-region> <shopCustomerId> <pspCustomerId>or to use a step-by-step wizard - run:
dcloud payments:customer-map:add