Configure DKCloudCommand

Use the config command to configure DKCloudCommand.

Get started

• For the first configuration, you will be prompted to set up the general credentials for DKCloudCommand and a default user context. Configuration for multiple user contexts is supported, but only a default configuration context is required.
• When prompted, enter the username and password (hidden) provided to you by DataKitchen. See step 2 below for an example.
• The default cloud address and port are also provided.
• By default, DKCloudCommand responses will also include an announcement of the context currently in use. This is most helpful if you have configured multiple contexts on the same local machine.
• The CLI is case-sensitive, even if your instance of shell is not. Use lowercase commands with the DKCloudCommand interface.
• Aside from the kitchen and recipe files located in your /Kitchens working directories, all local configuration and temporary files associated with DKCloudCommand are located in the {USER_HOME}/.dk directory. See step 3 below for an example of this directory.

Configure PyCharm CE IDE with DKCloudCommand

PyCharm Community Edition is one of many options for an IDE to use with DKCloudCommand.

1. Initiate the configuration with the config-list command:

   dk config-list
   

   If this is the first configuration, the command returns the following prompt:

   You are running an un-configured system!
   Let's run configuration before continuing.
   

2. Press Enter or Return, then enter the required information.

   Follow the syntax in the example below:

   Enter username: <USERNAME>
   Enter password: <PASSWORD>
   DK Cloud Address (default https://cloud.datakitchen.io): <ENTER>
   DK Cloud Port (default 443): <ENTER>
   
   DK Cloud Merge Tool Template (default None): /usr/local/bin/charm merge {{left}} {{right}} {{base}}
   DK Cloud File Diff Tool Template (default None): /usr/local/bin/charm diff {{local}} {{remote}}
   Check current working path against existing contexts?[yes/No] (default No):No
   Hide current context legend on each command response?[yes/No] (default No):No
   Skip checking the recipe locally, before recipe-update like commands?[yes/No] (default No):No
   

3. Review your local file structure.

   The contents of the {USER_HOME}/.dk directory will appear as follows:

   File / Directory	Description
   .context	Records your current user context, if you have configured multiple contexts.
   .latest_version	Records the current version of DKCloudCommand; used to prompt when upgrades are available.
   default/	Contains the configuration files for your default user context.
   .dk-credentials	Contains the web token for the configured user.
   config.json	Contains the username, password, hostname, and port information for the specified user.
   diffs/	Stores local, temporary files after you have executed diff operations from the command line.
   merges/	Stores local, temporary files after you have executed merge operations from the command line.
   general-config.json	Stores the config for local diff/merge tool; settings for working path warnings.
   another_context/	Contains the configuration files for a second user context.
   .dk-credentials config.json diffs/ merges/	Additional user contexts follow a directory and file structure similar to the default.

   Tip

   Hidden files and folders: You may need to turn on the ability to view hidden files and folders on your local machine in order to view the contents of {USER_HOME}/.dk. Consult documentation specific to your operating system for instructions.

4. After you have configured your default user, view your user information with the user-info command. Note that your role is configured by your account administrator.

   dk user-info
   

   Output: user-info command

   Name: <email>
   Email: <email>
   Customer Name: <customer>
   Support Email: <admin@datakitchen.io>
   Role: <role>
   

5. View the full details of your user's configuration by reissuing the config-list command:

   dk config-list
   

   Output: config-list command

   Current configuration is ...
   Customer Name:           <customer>
   Context:                 default
   Config Location:         /{USER_HOME}/.dk/default/config.json
   General Config Location: /{USER_HOME}/.dk/general-config.json
   Username:                <USERNAME>
   Password:                <PASSWORD>
   Cloud IP:                https://cloud.datakitchen.io
   Cloud Port:              443
   Merge Tool:              /usr/local/bin/charm merge {{left}} {{right}} {{base}}
   Diff Tool:               /usr/local/bin/charm diff {{local}} {{remote}}
   Check Working Path:      False
   Hide Context Legend:     False