vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Comparison of IBM Cloudant and Apache CouchDB API endpoints 

The IBM® Cloudant® for IBM Cloud® and Apache CouchDB 3.x API endpoints, and the methods for accessing them, are described here.

The table shows you which endpoints are present in the CouchDB or IBM Cloudant service.

Some CouchDB endpoints don't have IBM Cloudant equivalents because it wouldn't be meaningful. Similarly, some IBM Cloudant endpoints don't have CouchDB equivalents.

While IBM Cloudant is API-compliant with CouchDB, IBM Cloudant doesn't support URL rewrites from the JavaScript function.

For more information about a specific endpoint on a service, click the corresponding link.



Table 1. Compare IBM Cloudant and Apache CouchDB API endpoints

 Endpoint & Links Description 

 GET / <br>[Cloudant](https://cloud.ibm.com/apidocs/cloudantgetserverinformation), [CouchDB](https://docs.couchdb.org/en/latest/api/server/common.html) Retrieve meta-information about the instance. 
 GET /_active_tasks <br>[Cloudant](https://cloud.ibm.com/apidocs/cloudantgetactivetasks), [CouchDB](https://docs.couchdb.org/en/latest/api/server/common.htmlactive-tasks) Retrieve a list of running tasks. 
 GET /_all_dbs <br>[Cloudant](https://cloud.ibm.com/apidocs/cloudantgetalldbs), [CouchDB](https://docs.couchdb.org/en/latest/api/server/common.htmlall-dbs) Query a list of all database names in the instance. 
 POST /_api/v2/api_keys <br>[Cloudant](https://cloud.ibm.com/apidocs/cloudantpostapikeys) Generate an API key.
VSI on VPC landing zone - Standard variation 

The Standard variation of the VSI on VPC landing zone deployable architecture is based on the IBM Cloud for Financial Services reference architecture. The architecture creates a customizable and secure infrastructure, with virtual servers, to run your workloads with a Virtual Private Cloud (VPC) in multizone regions.



 Architecture diagram 

Zoom

![Architecture diagram for the Standard variation of VSI on VPC landing zone](https://cloud.ibm.com/docs-content/v1/content/9610604e9f8dcd5f7b6b138dd22ba445300be7f5/deployable-reference-architectures/terraform-ibm-landing-zone/vsi-vsi.drawio.svg)

Figure 1. Standard variation of VSI on VPC landing zone





 Design requirements 

Zoom

![Design requirements for VSI on VPC landing zone](https://cloud.ibm.com/docs-content/v1/content/9610604e9f8dcd5f7b6b138dd22ba445300be7f5/deployable-reference-architectures/terraform-ibm-landing-zone/heat-map-deploy-arch-slz-vsi.svg)

Figure 2. Scope of the design requirements





 Components 



 VPC architecture decisions 



Table 1. Architecture decisions

 Requirement Component Reasons for choice Alternative choice 

 <br><br> * Provide infrastructure and administration access<br> * Limit the number of infrastructure administration entry points to ensure security audit<br><br><br> Management VPC service Create a separate VPC service for management and maintenance of workload resources and access through a site-to-site VPN 
 <br><br> * Provide infrastructure for service management components like backup, monitoring, IT service management, shared storage<br> * Ensure you can reach all IBM Cloud and on-premises services<br><br><br> Workload VPC service Create a separate VPC service as an isolated environment to support hosted applications
To summarize, IBM Cloudant Geo is something unique to the IBM Cloudant service and is used to perform advanced geospatial queries against your databases of GeoJSON objects. It cannot be combined with other index types. It is only of use to Geographic Information Systems or use-cases that have a purely geographic purpose.





 What is changing? 

As of 1 February 2023, the following conditions apply:



* Users cannot query /$DATABASE/_design/$DDOCS/_geo endpoints. Requests to those endpoints return a 404 Not Found response.
* Users can define indexes by using the st_indexes keyword in design documents, but those indexes are ignored by the service. This practice ensures that existing design documents can be updated, and replications that contain geospatial indexes do not fail. Existing Geo indexes are deleted, and customers are no longer billed for the space they consume.
* IBM Cloud® support no longer answers questions or assists with issues that are related to the Geospatial feature of the IBM Cloudant service.







 Alternatives to geospatial 

Many simple geospatial queries can be done without using the Geospatial capability that was removed from the IBM Cloudant service. These alternatives are described in this [IBM Cloudant blog post](https://blog.cloudant.com/2022/06/28/Simple-Geospatial-Queries.html).







 Transaction Engine notice 

The IBM Cloudant on Transaction Engine service ends on 1 February 2023. You can no longer create new instances of IBM Cloudant on Transaction Engine. On 1 February 2023, all instances of IBM Cloudant on Transaction Engine will be permanently disabled and deprovisioned. Users of existing instances need to migrate from the service before the end of service date. You can find guidance on migrating from IBM Cloudant on Transaction Engine to IBM Cloudant Standard here: [Migrating from TXE](https://blog.cloudant.com/2022/01/14/Migrating-from-Cloudant-TXE-to-Standard).



 What is Transaction Engine? 

IBM Cloudant has an architecture option, which is underpinned by a Transaction Engine.
To achieve the goal of having a resilient architecture, the required deployment footprint differs between IaaS solutions like VMware and Kernel-based virtual machine (KVM) and Kubernetes (Kubernetes Service and Red Hat OpenShift on IBM Cloud) versus a fully-managed serverless service like Code Engine.





 Network architecture 

Review the following network architecture assumptions:



1. As a baseline, the current architecture and procedures being used today in a dedicated deployment also work in public isolated. This might not be the preferred architecture, but it should be used as a starting point. Public cloud offers more flexibility, agility, and customer control that might allow for changes from current procedures to save money, reduce effort, or provide other benefits than are available today with a dedicated cloud.
2. Users of the applications will not see any difference in their usage of the application, whether it's running in dedicated or public locations.
3. Administrators will manually decide when a failover occurs and trigger it manually.
4. All networking is preconfigured in both sites before any sort of disaster declaration.



* VPC subnets in all locations will have nonoverlapping CIDR blocks.
* Routes for CIDR blocks in one multizone region (MZR) are advertised to the other ones such that no routing changes are required in a disaster situation.



5. Provisioning of Event Streams Enterprise, IBM Cloudant, and other services that use dedicated hardware will need to be preprovisioned, as they might take human intervention and several days to provision. Event Streams might have automated provisioning on Enterprise Plan, but IBM Cloudant is manual per the IBM Cloudant documentation.
6. When applications deploy to production, they get deployed to both US South and US East regions, and deployment validation testing is performed in dark mode (in the backup MZR). The testing can be just enough to validate that the app is ready should it be necessary to fail over.
7. There is currently no feature set in IBM Cloud Code Engine to replicate the configuration of one project to another one in a different region. Therefore, the customer team needs to ensure that all necessary configuration changes to the IBM Cloud Code Engine projects in all the regions are enforced.



Zoom

!
Authenticating with IBM Cloudant FAQ 

IBM Cloud® Identity and Access Management (IAM) combines managing user identities, services, and access control into one approach. IBM® Cloudant® for IBM Cloud® integrates with IBM Cloud Identity and Access Management.



 What is the difference between IBM Cloudant legacy and IAM access controls? 



 IBM Cloud IAM 



* Centrally managed access management across IBM Cloud.
* Allows a user or service to access many different resources by using the same set of credentials (for example, same username and password or IAM API key).
* IAM API keys can be granted access to account management functions, like creating new databases.







 IBM Cloudant legacy 



* Unique to IBM Cloudant.
* Access to each service instance requires its own set of credentials.
* Uses HTTP basic authentication with credentials that aren't bound to an individual user or service.









 Why is the Use only IAM mode preferred? 

The Use only IAM mode means that only IAM credentials are provided through service binding and credential generation. You gain the following advantages when you use IBM Cloud IAM:



* Managing access to IBM Cloudant with the standard tooling of IBM Cloud.
* Using credentials that you can easily revoke and rotate when you use IBM Cloud IAM.



For more information about the advantages and disadvantages between these modes, see [Advantages and disadvantages of the two access control mechanisms](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-managing-access-for-cloudantadvantages-and-disadvantages-of-the-two-access-control-mechanisms-ai).





 How can I create an instance by using the command line? 

When you create a new IBM Cloudant instance from the command line, you must include the ibmcloud tool by using the -p parameter. This parameter enables or disables legacy credentials for an account by passing the option in JSON format. The option is called legacyCredentials.

To create an instance as Use only IAM, run the following command:

ibmcloud resource service-instance-create "Instance Name" cloudantnosqldb Standard us-south -p '{"legacyCredentials": false}'
FAQ - Provisioning, Plans, and Naming 

Frequently asked questions can produce helpful answers and insight into best practices for working with IBM Cloud® Object Storage.



 Why can I not create or delete a service instance? 

A user is required to have have at a minimum the platform role of editor for all IAM enabled services, or at least for Cloud Object Service. For more information, see the [IAM documentation on roles](https://cloud.ibm.com/docs/account?topic=account-iam-service-roles-actions).





 Which one of my instances uses a Lite plan? 

An account is limited to a single instance of IBM Cloud Object Storage that uses a Lite plan. You can find this instance three different ways:



1. Navigate to the [catalog](https://cloud.ibm.com/objectstorage/create) and attempt to make a new Lite instance. An error will pop up prompting you to delete the existing instance, and provides a link to the current Lite instance.
2. Navigate to the storage section of the resource list, and click on any area of blank space to select an instance of Object Storage. An informational sidebar will appear and provide the plan name: either Lite or Standard.
3. Use the CLI to search for the resource:



ibmcloud resource search "service_name:cloud-object-storage AND 2fdf0c08-2d32-4f46-84b5-32e0c92fffd8"





 How do I upgrade a service instance from Lite to Standard? 

Typically, this is easily done from the IBM Cloud Object Storage console found here [https://cloud.ibm.com/objectstorage/](https://cloud.ibm.com/objectstorage/), select the correct name of Cloud Object Storage Instance you wish to upgrade,click on Plan in the navigation menu, located after Instance Usage. Select the "standard" plan and hit save.

In cases where the instance has been locked due to exceeding the maximum allowed size of a Lite instance it may be necessary to use the CLI.
Upgrading 

Learn how to upgrade your service plan.

IBM Cloud

IBM Cloud only

This information applies only to managed deployments. For more information about upgrading an installed deployment that is hosted by IBM Cloud Pak for Data, see [Upgrading the service](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-upgrade-data).



 Upgrading your plan 

You can explore the Discovery [service plan options](https://www.ibm.com/cloud/watson-discovery/pricing-2/) to decide which plan is best for you.

The page header shows the plan you are using today.

Zoom

![Shows that the Plus plan is displayed in the page header](https://cloud.ibm.com/docs-content/v1/content/f16b1f78a92498247223b337bd9303c2758b9ba8/discovery-data/images/plan-in-header.png)

Figure 1. Plus plan is displayed in the page header

You cannot upgrade from any v1 plan to any v2 plan. For example, you cannot upgrade a Lite plan to a Plus, Enterprise, or Premium (v2) plan. And you cannot upgrade an Advanced, Partner, Standard, or Premium (v1) plan to an Enterprise or Premium (v2) plan. To start using v2, create a new Plus, Enterprise, or Premium plan.

For information about upgrading from a Lite to an Advanced v1 plan, see [Upgrading your service](https://cloud.ibm.com/docs/discovery?topic=discovery-upgrading-your-planservice) in the v1 documentation.

Even though you can use the Plus plan for the first 30 days at no charge, you must have a paid account to create a Plus plan. For more information about creating a paid account, see [Upgrading your account](https://cloud.ibm.com/docs/account?topic=account-upgrading-account).



1. How you upgrade depends on your plan.
Typically, these plans aren't selectable because they require assistance from the IBM Cloud Sales team or they require a migration before you can update plans. See the documentation for the specific service for information about the required next steps.



Depending on the type of plan updates you make, your next steps can vary. For example, if you reduced the pricing plan, restart your app. Or, if you upgraded the pricing plan, you might need to restart your app, and then take other actions.

Complete the following steps to restart your app:



1. Click the Navigation Menu icon ![Navigation Menu icon](https://cloud.ibm.com/docs-content/v1/content/9713d864488177dc6b273b53b7f2383a81f10bc1/icons/icon_hamburger.svg) > Resource List, and find the app that the service is bound to.
2. From the app menu, select Restart App.



For more information about any further required actions, see the documentation for the specific service.





 Updating a plan by using the CLI 

Complete the following steps to update a pricing plan by using the IBM Cloud command-line interface (CLI).



1. Check whether the service is enabled with the resource controller.

ibmcloud catalog service <service_name>

The output lists RC Compatible true. Make a note of the ID of the plan that you want to update to.

RC Compatible true
RC Provisionable true
IAM Compatible true
Children Name Kind ID
lite plan 4bcd3fgh-3cf2-47c0-93d4-d2f2289eac28
standard plan 264d0450-996d-4bcd-894d-fc7018dacf1e
2. Update the pricing plan for your service instance.



* If the service is enabled with the resource controller, run the [ibmcloud resource service-instance-update command](https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_commands_resourceibmcloud_resource_service_instance_update).
Using private endpoints allows customers to connect to an IBM Cloudant instance through the internal IBM Cloud® network to avoid upstream application traffic from going over the public network and incurring bandwidth charges. For more information, see [Cloud Service Endpoint documentation](https://cloud.ibm.com/docs/account?topic=account-service-endpoints-overview) for details about enabling Cloud Service Endpoints for your IBM Cloud® account.
* Users of an IBM Cloudant Dedicated Hardware plan environment can employ IP allowlisting by contacting support. IP allowlisting configuration applies to all instances that are running on the environment. The public and private network allowlists can be managed independently, and the public allowlist can be set to block all traffic so that all traffic goes over the private endpoints.



You can provision one or more Standard plan instances on a single Dedicated Hardware environment. The Dedicated Hardware environment expands or contracts as needed based on the throughput capacity and data that is used by the Standard plan instances. An IBM Cloudant Dedicated Hardware plan instance has a fixed price that is an addition to the consumption pricing of any Standard plan instances deployed on it. Billing is prorated daily, with a 1-month minimum duration charged for the environment. Provisioning of an IBM Cloudant Dedicated Hardware plan is asynchronous and can take 5-7 business days. To create an IBM Cloudant Dedicated Hardware plan instance and provision a Standard plan instance on it, follow the [Creating and leveraging an IBM Cloudant Dedicated Hardware plan instance on IBM Cloud](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-creating-and-leveraging-an-ibm-cloudant-dedicated-hardware-plan-instance-on-ibm-cloudcreating-and-leveraging-an-ibm-cloudant-dedicated-hardware-plan-instance-on-ibm-cloud) tutorial.

The Dedicated Hardware plan isn't available to IBM Cloud Dedicated customers. The Dedicated Hardware plan is only available to IBM Cloud customers.







 Request classes 

Throughput provision is identified and measured as one of the following types of request classes:



1. Reads (formerly called lookups) which are described in this list.



1.
Comparing Cloud Foundry and Code Engine terms 

Before you get started with deploying apps in Code Engine, learn the basics about Code Engine. The following table describes some high-level terminology differences between Cloud Foundry and Code Engine.



Table 1. Terminology

 Cloud Foundry Code Engine Description 

 Org and Space Resource group and projects A grouping of workloads. The specific choice of which workload goes into each grouping is defined by the user. "Resource groups" are an IBM Cloud concept, while "projects" are Code Engine specific. Projects provide a level of isolation between workloads. See [Managing projects](https://cloud.ibm.com/docs/codeengine?topic=codeengine-manage-project). 
 Application Application (app) A workload that responds to HTTP requests from a REST API, a web page request, or an event, for example. Code Engine requires that applications include the HTTP server as part of the code. Applications automatically scale (up and down) based on the incoming load. You can configure the minimum and maximum scale if needed. By default, the application listens on port 8080. You can override this behavior by using the console or with the CLI --port option. See [Working with apps in Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-application-workloads). 
 N/A Job or batch job A job runs one or more instances of your executable code. Unlike applications, which handle HTTP requests, jobs are designed to run one time and exit. When you create a job, you can specify workload configuration information that is used each time that the job is run. See [Working with jobs and job runs](https://cloud.ibm.com/docs/codeengine?topic=codeengine-job-plan). 
 cf push Build and deploy Process of building a container image from source code and deploying an app in a single step. You can build code based on a Dockerfile or that use a Paketo buildpack. You can build from a single step in the CLI as well as from the Code Engine console.
And, if they find that the Plus plan does not meet their needs for any reason, they can always downgrade back to their Standard plan.





 What pricing plan do I need to use the service's customization interface? 

You must have a paid plan (Plus, Standard, or Premium) to use language model or acoustic model customization. Users of the Lite plan cannot use customization. To use customization, users of the Lite plan must upgrade to a paid plan such as the Plus plan.





 How do I upgrade from the Lite plan to the Plus plan? 

You can upgrade from the Lite plan to the Plus plan, for example, to gain access to customization. To upgrade from the Lite plan to the Plus plan, use the Upgrade button in the resource catalog page for your service instance:



* From the [resource list](https://cloud.ibm.com/resources), click on your Speech to Text instance to go to the Speech to Text dashboard page.
* From the Manage page, click Upgrade to move to the Plus plan.
* Follow the steps on the Plan page to complete your upgrade.







 What does "pricing per minute" mean? 

For the Plus plan, pricing is based on the cumulative amount (number of minutes) of audio that you send to the service in any one month. The per-minute price of all audio that you recognize in a month is reduced once you reach the threshold of one million minutes of audio for that month. The price does not depend on how long the service takes to process the audio. (Per-minute pricing is different for the Standard plan.)

For information about pricing for the Plus and Standard plans, see the Speech to Text service in the [IBM Cloud® Catalog](https://cloud.ibm.com/catalog/speech-to-text).





 Do you round up to the nearest minute for every call to the API? 

IBM does not round up the length of the audio for every API call that the service receives. Instead, IBM aggregates all usage for the month and rounds to the nearest minute at the end of the month. For example, if you send two audio files that are each 30 seconds long, IBM sums the duration of the total audio for that month to one minute.
Tekton provides a set of shared components for building [continuous integration](https://www.ibm.com/garage/method/practices/code/practice_continuous_integration/) and [continuous delivery](https://www.ibm.com/garage/method/practices/deliver/practice_continuous_delivery/) systems. As an open source project, Tekton is managed by the [Continuous Delivery Foundation](https://cd.foundation/). The goal is to modernize continuous delivery by providing industry specifications for pipelines, workflows, and other building blocks. With Tekton, you can build, test, and deploy across cloud providers or on-premises systems by abstracting the underlying implementation details. Tekton pipelines are built into [Continuous Delivery](https://www.ibm.com/cloud/blog/announcements/build-and-deliver-using-tekton-enabled-pipelines). For more information about the IBM Cloud® Kubernetes Service, see [IBM Cloud® Kubernetes Service](https://www.ibm.com/garage/method/practices/run/tool_ibm_container).

The template that is used in this tutorial works with either the Standard or Lite plan for Kubernetes. With the Standard plan, you can access your app by way of the DNS name. In the Lite plan, you can access your app by using [nodeport](https://cloud.ibm.com/docs/containers?topic=containers-nodeportnodeport_planning).

You can use a deployment strategy to update an application in a production environment, in a controlled manner. Using a deployment strategy can provide the following benefits:



* Avoid application downtime.
* Enable production testing of new functions without impacting customers.
* Limit the impact of production issues to a subset of users.
* Enable rapid rollback to the previous version if issues are found.



Many possible deployment strategies are available. In general, they depend on running multiple instances of the application and managing how the various instances are updated. You can pre-configure the following common deployment strategies in Continuous Delivery:

Basic