Skip to content

Commit 69149bf

Browse files
Merge pull request #10 from hummusonrails/readme-cbsh
update instructions on getting cbshell config
2 parents 9227128 + d41384b commit 69149bf

File tree

3 files changed

+11
-48
lines changed

3 files changed

+11
-48
lines changed

README.md

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -92,30 +92,11 @@ Once you have opened this repositority in a [GitHub Codespace](https://codespace
9292

9393
First, edit the `./config_file/config` file with your Couchbase Capella information.
9494

95-
Under the `[[cluster]]` section:
96-
97-
- Replace the empty string value for `identifier` with the name of the cluster you created earlier.
98-
- Replace the empty string value for `connstr` with the connection string to your cluster.
99-
- Found in `Menu > Connect`
100-
![](workshop_images/menu_with_connect_highlighted.png)
101-
- Replace the empty string for `default_bucket` with the name of the bucket you created earlier.
102-
- Replace the empty strings for `username` and password with the username and password of your Couchbase Capella account.
103-
- Found in `Menu > Settings > Cluster Access`
104-
![](workshop_images/menu_with_settings_highlighted.png)
105-
- Replace the empty string for `capella_organization` with the name of your organization.
106-
- Found by clicking on your avatar icon (usually your initials) then `Organizations`
107-
- Change the name of your organization if multiple words to use dashes instead of spaces, i.e. "My Organization" becomes "my-organization".
108-
![](workshop_images/menu_with_organizations_highlighted.png)
109-
110-
Under the `[[capella-organization]] section:
111-
112-
- Replace the `identifier` empty string value with the name of your organization like the last step above.
113-
- Replace the `access-key` and `secret_key` empty strings values with the access key for your organization.
114-
- Found in `Menu > Settings > API Keys`
115-
![](workshop_images/menu_with_api_keys_highlighted.png)
116-
- Replace the `default-project` empty string value with the name of the project you created earlier.
117-
- Found in the top-level view of all your clusters.
118-
![](workshop_images/cluster_list_with_project_name.png)
95+
You can find a pre-filled config file in the Couchbase Capella dashboard under the "Connect" tab.
96+
97+
Once you click on the "Connect" tab, you will see a section called "Couchbase Shell" among the options on the left-hand menu. You can choose the access credentials for the shell and copy the config file contet provided and paste it in the `./config_file/config` file.
98+
99+
<img src="workshop_images/get_cbshell_config.png" alt="Get Couchbase Shell config file data" width="50%">
119100

120101
#### Import Data with Couchbase Shell
121102

config_file/config

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,8 @@
1+
# cbsh config file
12
version = 1
2-
llms = []
3-
43
[[cluster]]
5-
identifier = "" # This is the name of the cluster you created
6-
connstr = "" # This is the connection string for the cluster and can be found in the Capella UI
7-
default-bucket = "" # This is the name of the bucket you created
8-
username = "" # This is the username you created in the connect settings in the Capella UI
9-
password = "" # This is the password you created in the connect settings in the Capella UI
10-
default-collection = "_default" # Keep these as is unless you changed the defaults in the Capella UI
11-
default-scope = "_default" # Keep these as is unless you changed the defaults in the Capella UI
12-
data-timeout = "10s" # Keep as is
13-
connect-timeout = "1m 15s" # Keep as is
14-
search-timeout = "1m 15s" # Keep as is
15-
analytics-timeout = "1m 15s" # Keep as is
16-
management-timeout = "1m 15s" # Keep as is
17-
transaction-timeout = "1m 15s" # Keep as is
18-
tls-enabled = true # Keep as is
19-
tls-accept-all-certs = true # Keep as is
20-
capella-organization = "" # This is the name of the your organization, if multiple words use a hyphen and lowercase
21-
22-
[[capella-organization]]
23-
identifier = "" # This is the name of the your organization, if multiple words use a hyphen and lowercase
24-
access-key = "" # This is the access key for your organization found in the Capella UI
25-
secret-key = "" # This is the secret key for your organization found in the Capella UI
26-
default-project = "" # This is the name of the project you created where all your clusters are stored
4+
identifier = "capella"
5+
connstr = "" # Replace this with connection string from cluster access credentials
6+
user-display-name = "" # Your display name here
7+
username = "" # Replace this with username from cluster access credentials
8+
password = "<<password>>" # Replace this with password from cluster access credentials
113 KB
Loading

0 commit comments

Comments
 (0)