Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-12086

Add shell to Capella KV guides

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • Major
    • Trinity.M1
    • Capella
    • query

    Description

      Fill gaps in the the Key-Value operations guides for Capella caused by the lack of "official" command line clients. Two options were considered:

      1. Add cbc and cbc-subdoc instructions wherever the devex docs for Server use these tools
      2. Add Couchbase Shell instructions, if possible, using the doc command

      At the moment, since cbc and cbc-subdoc are unavailable for Capella, it looks like we'll be going for option 2, Couchbase Shell. Note that this ticket only applies to the devex docs in Capella; we are not replacing the cbc or cbc-subdoc documentation in the Server devex docs.

      Gaps in the KV Developer Documentation for Capella

      Create Documents for Server has instructions for cbc.
      Create Documents for Capella has no command-line option.

      Read Documents for Server has instructions for cbc and cbc-subdoc.
      Read Documents for Capella has no command-line option.

      Update Documents for Server has instructions for cbc and cbc-subdoc.
      Update Documents for Capella has no command-line option.

      Delete Documents for Server has instructions for cbc and cbc-subdoc.
      Delete Documents for Capella has no command-line option.

      To standardize on CB shell as the KV command-line tool for Capella ...

      No extra effort required. The doc command in CB shell covers all the examples given for cbc and cbc-subdoc in the devex docs.

      To make cbc and cbc-subdoc available in Capella ...

      We would have to do the following:

      • Make cbc and cbc-subdoc available in the Couchbase Server Tools download.
      • Add cbc and cbc-subdoc to the Connect section in the Capella UI, enabling users to do the following:
        • get a connection string;
        • specify a user and set access;
        • specify allowed IP addresses;
        • download the root certificate and tell users how to specify the client key and chain certificate;
        • generate a copy-and-paste command containing all this information.

      Just as we do for cbsh, the SDKs, and the other command line tools.

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              simon.dew Simon Dew
              simon.dew Simon Dew
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty