vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Getting started with Tomcat 

IBM® Cloud Foundry is deprecated and no longer supported as of 1 June 2023. For more information, see the [deprecation details](https://cloud.ibm.com/docs/cloud-foundry-public?topic=cloud-foundry-public-deprecationdep_details).

Congratulations, you deployed a Hello World sample app on IBM Cloud®! To get started, follow this step-by-step guide. Or, [download the sample code](https://github.com/IBM-Cloud/get-started-tomcat) and explore on your own.

By following this getting started tutorial, you'll set up a development environment, deploy an app locally on IBM Cloud®, and integrate a database service in your app.

Throughout these docs, references to the Cloud Foundry CLI are now updated to the IBM Cloud CLI! The IBM Cloud CLI has the same familiar Cloud Foundry commands, but with better integration with IBM Cloud accounts and other services. Learn more about getting started with the IBM Cloud CLI in this tutorial.



 Before you begin 

You'll need the following:



* [IBM Cloud account](https://cloud.ibm.com/registration)
* [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli)
* [Git](https://git-scm.com/downloads)
* [Maven](https://maven.apache.org/download.cgi)
* [Apache Tomcat version 8.0.41](https://tomcat.apache.org/download-80.cgi8.0.41)







 Step 1: Clone the sample app 

Clone the repository and change to the directory to where the sample app is located.

git clone https://github.com/IBM-Cloud/get-started-tomcat

cd get-started-tomcat

Review the files in the get-started-tomcat directory to familiarize yourself with the contents.





 Step 2: Run the app locally
Creating and populating a database 

This tutorial shows you how to use the [Python programming language](https://www.python.org/) to create an IBM® Cloudant® for IBM Cloud® database in your IBM Cloud service instance. You also learn how to populate the database with a simple collection of data.

This tutorial doesn't use the most efficient Python code. The intent is to show simple and easy-to-understand working code that you can learn from and apply to your own applications. You must apply normal best practices for checking and handling all warning or error conditions that are encountered by your own applications.



 Objectives 

This tutorial builds on a series of Python language instructions, suitable for the following tasks:



1. Connecting to an IBM Cloudant service instance on IBM Cloud®.
2. Creating a database within the service instance.
3. Storing a small collection of data as documents within the database.
4. Retrieving data.
5. Deleting the database.
6. Closing the connection to the service instance.







 Before you begin 

This tutorial provides you with the following options:



* Follow each step as outlined in this tutorial.
* Or [execute the Python script](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-creating-and-populating-a-simple-ibm-cloudant-database-on-ibm-cloudexecute-the-complete-python-script), and come back to [Step 5. Retrieving data](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-creating-and-populating-a-simple-ibm-cloudant-database-on-ibm-cloudretrieving-data).







 Installing Python 

Normally, you don't run commands individually in Python. You usually create a script, which is a list of the commands you want to run, stored in a Python file, with a py extension.



1. Set up service credential requirements.

a.
Getting started with IBM Cloud Pak for Multicloud Management 

To get started with IBM Cloud Pak for Multicloud Management, go to the information for the specific version that you are installing here:



*  [Getting started with IBM Cloud Pak for Multicloud Management V2.3](https://cloud.ibm.com/docs/cloud-pak-multicloud-management?topic=cloud-pak-multicloud-management-getting-started-23)
*  [Getting started with IBM Cloud Pak for Multicloud Management V2.1](https://cloud.ibm.com/docs/cloud-pak-multicloud-management?topic=cloud-pak-multicloud-management-getting-started-21)
*  [Getting started with IBM Cloud Pak for Multicloud Management V2.0](https://cloud.ibm.com/docs/cloud-pak-multicloud-management?topic=cloud-pak-multicloud-management-getting-started-20)
*  [Getting started with IBM Cloud Pak for Multicloud Management V1.3](https://cloud.ibm.com/docs/cloud-pak-multicloud-management?topic=cloud-pak-multicloud-management-getting-started-13)
Creating and populating a database 

This tutorial shows you how to use the [Python programming language](https://www.python.org/) to create an IBM® Cloudant® for IBM Cloud® database in your IBM Cloud service instance. You also learn how to populate the database with a simple collection of data.

This tutorial doesn't use the most efficient Python code. The intent is to show simple and easy-to-understand working code that you can learn from and apply to your own applications. You must apply normal best practices for checking and handling all warning or error conditions that are encountered by your own applications.



 Objectives 

This tutorial builds on a series of Python language instructions, suitable for the following tasks:



1. Connecting to an IBM Cloudant service instance on IBM Cloud®.
2. Creating a database within the service instance.
3. Storing a small collection of data as documents within the database.
4. Retrieving data.
5. Deleting the database.
6. Closing the connection to the service instance.







 Before you begin 

This tutorial provides you with the following options:



* Follow each step as outlined in this tutorial.
* Or [execute the Python script](https://cloud.ibm.com/docs/services/Cloudant?topic=Cloudant-creating-and-populating-a-simple-ibm-cloudant-database-on-ibm-cloudexecute-the-complete-python-script), and come back to [Step 5. Retrieving data](https://cloud.ibm.com/docs/services/Cloudant?topic=Cloudant-creating-and-populating-a-simple-ibm-cloudant-database-on-ibm-cloudretrieving-data).







 Installing Python 

Normally, you don't run commands individually in Python. You usually create a script, which is a list of the commands you want to run, stored in a Python file, with a py extension.



1. Set up service credential requirements.

a.
[Select Standard Analyzer, and click Create Document and Build Index to create a search index.](https://cloud.ibm.com/docs-content/v1/content/522c6f62358b063f921283400a601c3f9bc66f08/Cloudant/images/indexingdashboard4.png)

Figure 3. New Search Index window



You can then build complex queries that involve one, some, or all of the indexed fields combined with AND and OR operators.

IBM Cloudant Search is best if you have many search use-cases involving different combinations of fields.

For more information, see the following resources:



* IBM Cloudant Search uses "analyzers" to pre-process text before indexing. Learn about [Search Analyzers](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-search-analyzers) to ensure you get the results that you expect.
* [IBM Cloudant Search documentation](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-cloudant-search)







 Step 4. Aggregating data - MapReduce 

IBM Cloudant Query and IBM Cloudant Search cannot aggregate search results. In other words, you can't ask, How many books were published in 1973? IBM Cloudant's MapReduce feature allows secondary indexes to be created that can be used for selection or aggregation. MapReduce indexes are, like IBM Cloudant Search, which is created by supplying a JavaScript function - any call to an emit function adds a row to the index.



1. From the IBM Cloudant Dashboard, select the books database.
2. Select the Design Documents tab.
3. Select New View from the menu.
4. Keep New document in the drop-down field.
5. Enter a name in the Index name field. This name is the new view name.
6. Select _count from the Reduce (optional) drop-down menu. This way our results are counted.
7.
Account: YOURs Account (32cdeadbeefdeadbeef1234132412343) <-> 1234567
Resource group: YOUR resource group
CF API endpoint:
Org:
Space:
3. Use the helper script provided by IBM to create the following resources:



* IBM Cloud API key that represents you and your permissions to use IBM Cloud
* Kubernetes Secret named secret-ibm-cloud-operator in the default namespace. This secret has the keys api-key and region. The operator will use this data to create the cloudant service instance.
* Kubernetes ConfigMap resource with the name config-ibm-cloud-operator in the default namespace to hold the region and resource group



Use the supplied curl command:

curl -sL https://raw.githubusercontent.com/IBM/cloud-operators/master/hack/configure-operator.sh | bash
4. Back in the Red Hat OpenShift web console, click the Create instance under the Service tab on the Installed Operators of the IBM Cloud Operator page and select YAML view to bring up the yaml editor.
5. Make the suggested substitutions where the serviceClass is cloudantnosqldb and the plan can be lite or standard (only one lite plan is allowed per account). Replace <your-initials>:

apiVersion: ibmcloud.ibm.com/v1
kind: Service
metadata:
annotations:
ibmcloud.ibm.com/self-healing: enabled
name: <your-initials>-cloudant-service
namespace: example-health
spec:
serviceClass: cloudantnosqldb
plan: standard
6. Click Create to create a IBM Cloudant database instance. Your context should be Operators > Installed Operators > IBM Cloud Operator in the Administrator perspective with Project: example-health in the Service panel.
7. Click on the service just created, <your-initials>-cloudant-service and over time the state field will change from provisioning to Online meaning it is good to go.
8.
<br><br> * Node.js 10<br> * Node.js 12<br> * Python 3<br> * PHP 7<br><br><br> [Code](https://github.com/ibm-functions/template-reminder-slack) 







 Deploying the IBM Cloudant Events template 

The IBM Cloudant template creates a sequence of actions and a trigger that invokes that sequence. The trigger is fired when a change is made in the connected IBM Cloudant example database.

When you deploy this template, you create the following entities:



* An action called process-change.
* A sequence that uses the process change action as well as a preinstalled action for IBM Cloudant called read that reads entries from the IBM Cloudant database.
* A user-named trigger that is fired whenever an entry is added to the connected database. This trigger calls the sequence.



Before you begin

You must have an instance of [IBM Cloudant](https://cloud.ibm.com/catalog/services/cloudant) set up before you deploy this quick start template. When you create your IBM Cloudant instance, you must select Use both legacy credentials and IAM as your available authentication methods. This template does not work with an IBM Cloudant instance that uses IAM only.



1. After your IBM Cloudant instance is provisioned, select the instance from the Resource list and then select Launch Cloudant Dashboard.
2. From the IBM Cloudant Dashboard, click Create Database.
3. Create a non-partitioned database called cats.
4. From the IBM Cloudant instance, select Service credentials. If you do not have service credentials set up, click New Credentials to create them. These values are required for deploying this template.



Now that your instance of IBM Cloudant is provisioned and a sample database of cats set up, you are ready to deploy the IBM Cloudant Events template.



 Deploying the IBM Cloudant Events template from the console 

Deploy the IBM Cloudant Events template from the console.

Before you begin

Select a namespace to contain your Cloud Functions entities from the [console](https://cloud.ibm.com/functions).
Getting started with Ruby 

IBM® Cloud Foundry is deprecated and no longer supported as of 1 June 2023. For more information, see the [deprecation details](https://cloud.ibm.com/docs/cloud-foundry-public?topic=cloud-foundry-public-deprecationdep_details).

Congratulations, you deployed a Hello World sample app on IBM Cloud®! To get started, follow this step-by-step guide. Or, [download the sample code](https://github.com/IBM-Cloud/get-started-ruby) and explore on your own.

By following this getting started tutorial, you'll set up a development environment, deploy an app locally on IBM Cloud®, and integrate a database service in your app.

Throughout these docs, references to the Cloud Foundry CLI are now updated to the IBM Cloud CLI! The IBM Cloud CLI has the same familiar Cloud Foundry commands, but with better integration with IBM Cloud accounts and other services. Learn more about getting started with the IBM Cloud CLI in this tutorial.



 Before you begin 

You'll need the following:



* [IBM Cloud account](https://cloud.ibm.com/registration)
* [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli)
* [Git](https://git-scm.com/downloads)
* [Ruby](https://www.ruby-lang.org/en/downloads/)
* [rbenv](https://github.com/rbenv/rbenvinstallation)







 Step 1: Clone the sample app 

First, clone the repo and change the directory to where the sample app is located.

git clone https://github.com/IBM-Cloud/get-started-ruby

cd get-started-ruby





 Step 2: Run the app locally (optional) 



1. Run the app locally by running the following commands.

rbenv install 2.3.0
* Install the Terraform CLI and configure the IBM Cloud Provider plug-in for Terraform. For more information, see the tutorial for [Getting started with Terraform on IBM Cloud®](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-getting-started). The plug-in abstracts the IBM Cloud APIs that are used to complete this task.
* Create a Terraform configuration file that is named main.tf. In this file, you define resources by using HashiCorp Configuration Language. For more information, see the [Terraform documentation](https://www.terraform.io/docs/language/index.html).





 Importing accounts by using Terraform 

Use the following steps to import an existing account in an enterprise resource by using Terraform.



1. Create an argument in your main.tf file. The following example imports an account by using the ibm_enterprise_account resource, where enterprise_id is where the account is imported. You must have an existing IAM ID of an enterprise primary contact in order to complete the task.

resource "ibm_enterprise_account" "enterprise_import_account"{
parent = "parent"
enterprise_id = "enterprise_id"
account_id = "account_id"
}

You can specify the ID of an account that needs to be imported on the account_id option. For more information, see the argument reference details on the [Terraform Enterprise Management](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/enterprise_account) page.
2. After you finish building your configuration file, initialize the Terraform CLI. For more information, see [Initializing Working Directories](https://www.terraform.io/cli/init).

terraform init
3. Provision the resources from the main.tf file. For more information, see [Provisioning Infrastructure with Terraform](https://www.terraform.io/cli/run).
* [Setup](https://cloud.ibm.com/docs/account?topic=account-userapikey&interface=ui) an API key.



* IBM Cloud CLI,



* Install IBM Cloud command line (CLI) tooling. See [Getting started with the IBM Cloud CLI](https://cloud.ibm.com/docs/cli).
* Install IBM Cloud VPC plugin (vpc-infrastructure)
* Install DNS Services plugin (cloud-dns-services)



* Install jq i.e. [json query](https://stedolan.github.io/jq/) on your workstation used to query JSON files.
* SSH key



* Create an SSH key on your workstation and [import](https://cloud.ibm.com/docs/vpc?topic=vpc-ssh-keys) it to the IBM Cloud VPC.
* If you don't already have an SSH key, see the [instructions](https://cloud.ibm.com/docs/vpc?topic=vpc-ssh-keyslocating-ssh-keys) for creating a key for IBM Cloud VPC.





You will find instructions to download and install these tools for your operating environment in the [Getting started with tutorials](https://cloud.ibm.com/docs/solution-tutorials?topic=solution-tutorials-tutorials) guide.

To avoid the installation of these tools you can use the [Cloud Shell](https://cloud.ibm.com/shell) from the IBM Cloud console.





 Step 1: Target a resource group 



1. [Login](https://cloud.ibm.com/docs/cli?topic=cli-getting-started) with IBM Cloud CLI with username and password, or use the API key.
2. Specify the target resource group for your resources. You can list the available resource groups with the following command.

ibmcloud resource groups
* UI
* CLI







 Getting started with IBM Cloud Kubernetes Service 

Deploy highly available containerized apps in Kubernetes clusters and use the powerful tools of IBM Cloud® Kubernetes Service to automate, isolate, secure, manage, and monitor your workloads across zones or regions.

First, create a cluster in the IBM Cloud console or IBM Cloud Kubernetes Service CLI. Then, deploy your first containerized app to your cluster.

To complete the getting started tutorial, use a [Pay-As-You-Go or Subscription IBM Cloud account](https://cloud.ibm.com/docs/account?topic=account-upgrading-account) where you are the owner or have [full Administrator access](https://cloud.ibm.com/docs/account?topic=account-assign-access-resources).



 Creating a free classic cluster in the IBM Cloud console 

The free tier option is deprecated and will be unsupported on 25 July 2023. Existing free tier clusters will be allowed to finish their 30-day trial window. If you want to try IBM Cloud Kubernetes Service, [contact IBM Sales](https://www.ibm.com/account/reg/us-en/signup?formid=MAIL-wcp).



1. In the [IBM Cloud Catalog](https://cloud.ibm.com/catalog?category=containers), select Kubernetes Service. A cluster configuration page opens.
2. From the plan dropdown, select the Free cluster option.
3. Give your cluster a unique name, such as mycluster-free.
4. Select a resource group to create the cluster in, such as default.
5. In the Summary pane, review the order summary and then click Create. A worker pool is created that contains one worker node in the default resource group.



The worker node can take a few minutes to provision, but you can see the progress in the Worker nodes tab.
Getting started with ASP.NET Core 

IBM® Cloud Foundry is deprecated and no longer supported as of 1 June 2023. For more information, see the [deprecation details](https://cloud.ibm.com/docs/cloud-foundry-public?topic=cloud-foundry-public-deprecationdep_details).

Congratulations, you deployed a Hello World sample app on IBM Cloud®! To get started, follow this step-by-step guide. Or, [download the sample code](https://github.com/IBM-Cloud/get-started-aspnet-core) and explore on your own.

By following this getting started tutorial, you'll set up a development environment, deploy an app locally and on IBM Cloud®, and integrate an IBM Cloud® database service in your app. The ASP.NET core is complied into a .dll package. You can deploy the app with the code or with the precompiled file (.DLL) of your app.



 Before you begin 

You'll need the following:



* [IBM Cloud account](https://cloud.ibm.com/registration)
* [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-getting-started)
* [Git](https://git-scm.com/downloads)
* Install .NET Core SDK 3.1 from the [.NET Core downloads website](https://dotnet.microsoft.com/download).







 Step 1: Clone the sample app 

First, clone the sample app GitHub repo.

git clone https://github.com/IBM-Cloud/get-started-aspnet-core





 Step 2: Run the app locally 



1. On the command line, change the directory to where the sample app is located.

cd get-started-aspnet-core/src/GetStartedDotnet
2. Run the app locally by running the following commands.

dotnet restore

dotnet run
3.
Getting set up to sell services 

Welcome to IBM Cloud®! To start onboarding your service to our cloud platform, first complete a few tasks: provide your company and product details, create a test environment, and set up access for your team to help with the onboarding process.

It's recommended that you use an account that was created with a [functional ID](https://cloud.ibm.com/docs/account?topic=account-identity-overviewfunctionalid-bestpract) to ensure your continued access to the products that are onboarded in the account.



 Watch and learn 

Onboarding your product to IBM Cloud involves four major steps: registering in Partner Center, customizing your product details, building a service broker and validating your pricing plan, and, finally, publishing your product. Check out the following video for a walk-through of the complete process.



* Video transcript

By building, onboarding, and selling your product on IBM Cloud, you can grow your business and expand your reach to clients globally. You'll have the advantage of accelerated time to market, along with flexibility and security options that are available across open source technologies as well as computing resources in the cloud.

Onboarding your product involves four major steps:



* Registering in Partner Center
* Customizing your product details
* Building a service broker and validating your pricing plan
* And, finally, publishing your product



Get started by heading to Partner Center - your one-stop shop for onboarding your product. First, register your product by providing the name of your company and then creating your test environment. [On the Get started dashboard, enter your company name, and click Save. In the Create your test environment section, click Create]

Next, if you want team members to help with the onboarding process, get them set up with access to your account. For example, add a technical team member to create and add your broker. [In the Assign access section, click Assign to create an access group. Then, click Let's go.]

Confirm your legal agreement with IBM. Or, you can upload your own custom agreement. [Go to the My company page to confirm your legal agreement]

Go back to the My products page and click Create.
Prerequisites 



* If you do not have one, create an [IBM Cloud Pay-As-You-Go or Subscription IBM Cloud account](https://cloud.ibm.com/registration).
* Install the [IBM Cloud command line and the IBM Cloud Kubernetes Service command line plug-in](https://cloud.ibm.com/docs/cli?topic=cli-getting-started).
* Follow the [instructions](https://cloud.ibm.com/docs/containers?topic=containers-clusterscluster_prepare) to make sure that you are assigned the required permissions in Identity and Access Management (IAM) to create clusters and that your account is enabled for Virtual Routing and Forwarding (VRF).







 Step 1: Prepare your Terraform on IBM Cloud environment 



1. [Install the Terraform on IBM Cloud command line and the IBM Cloud Provider plug-in](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-setup_cli).
2. If you do not have one, [create an IBM Cloud API key](https://cloud.ibm.com/docs/account?topic=account-userapikeycreate_user_key).
3. Create an Terraform on IBM Cloud project directory. The directory will hold all your Terraform on IBM Cloud configuration files that you create as part of this tutorial. The directory in this tutorial is named tf-cluster, but you can use any name for the directory.

mkdir tf-cluster && cd tf-cluster
4. In your project directory, create a terraform.tfvars file and add the IBM Cloud API key that you created earlier. The terraform.tfvars file is an Terraform on IBM Cloud variables file that you store on your local machine. When you initialize the Terraform on IBM Cloud CLI, all variables that are defined in this file are automatically loaded into Terraform on IBM Cloud and you can reference them in every Terraform on IBM Cloud configuration file in the same project directory.