vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Glossary 



Definitions of Discovery terms

 Term Definition 

 Classifier A resource that you can train to recognize document types and categorize them in your collection. You can create two types of classifiers, a text classifier and a document classifier. A text classifier can classify documents based on words and phrases that are extracted from the body text with their part of speech information taken into account. A document classifier can classify documents based on words and phrases that are extracted from the body text fields with information from their part of speech and the other enrichments that are applied to the body text taken into account. The information from the other nonbody fields are also used. [Learn more](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-cm-doc-classifier) 
 Collection A set of documents that you can enrich and later search for meaningful information. [Learn more](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-collections). 
 Content Intelligence A feature that you can use to enrich documents in a Document Retrieval project such that the project can recognize information that is relevant to business contracts. A Document Retrieval project with this feature enabled is referred to as a Document Retrieval for Contracts project type. [Learn more](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-projectsdoc-retrieval-contracts) 
 Data source An external application or service where valuable knowledge resources are stored. Connect to a service where your data is stored so you can crawl the data without having to move it. [Learn more](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-collections). 
 Domain-specific Relates to terms and concepts that have special meaning to an industry or business. In tennis, for example, the term love has a special meaning. It represents a zero score. If you built a tennis-related application, you would teach Discovery that the term love has a meaning in the domain of tennis that is different from the generally understood meaning. 
 Enrichment What you add to documents in your collection to identify or tag terms in the document that are significant.
"name": "serviceInstance",
"value": "CLUSTER-ID"
}
]
}
],
"operations": {
"api_types": [
{
"api_type_id": "crn:v1:bluemix:public:containers-kubernetes::::api-type:cluster"
}
]
},
"contexts": [
{
"attributes":
{
"name": "networkZoneId",
"value": "NETWORK-ZONE-ID"
},
{
"name": "endpointType",
"value": "private"
}
]
}
]
}





 Creating rules from the CLI 



1. To create rules from the CLI, [install the CBR CLI plug-in](https://cloud.ibm.com/docs/cli?topic=cli-cbr-plugininstall-cbr-plugin).
2. You can use the ibmcloud cbr rule-create[command](https://cloud.ibm.com/docs/cli?topic=cli-cbr-plugincbr-cli-rule-create-command) to create CBR rules. For more information, see the CBR [CLI reference](https://cloud.ibm.com/docs/cli?topic=cli-cbr-plugincbr-zones-cli). Note that the service_name for IBM Cloud Kubernetes Service is containers-kubernetes. To find a list of service names, run the ibmcloud cbr service-ref-targets command. To find a list of API types for a service, run the ibmcloud cbr api-types --service-name SERVICE command.



Example command to create a rule that uses the addresses key and the cluster API type and the ipAddress type.
* Managing apps with Satellite Config



* [Understanding Satellite Config ](https://cloud.ibm.com/docs/satellite?topic=satellite-cluster-config)
* Setting up clusters to use with Satellite Config



* [Granting Satellite Config access to your clusters](https://cloud.ibm.com/docs/satellite?topic=satellite-setup-clusters-satconfig)
* [Setting up cluster groups](https://cloud.ibm.com/docs/satellite?topic=satellite-setup-clusters-satconfig-groups)
* [Registering clusters with Satellite Config](https://cloud.ibm.com/docs/satellite?topic=satellite-register-openshift-clusters)



* [Verifying cluster status](https://cloud.ibm.com/docs/satellite?topic=satellite-satconfig-verify-cluster-status)
* [Syncing subscription identity](https://cloud.ibm.com/docs/satellite?topic=satellite-sat-sync-sub-identity)
* Creating and managing Satellite configurations



* [Managing GitOps configurations](https://cloud.ibm.com/docs/satellite?topic=satellite-satcon-manage-gitops)
* [Managing Direct Upload configurations](https://cloud.ibm.com/docs/satellite?topic=satellite-satcon-manage-direct-upload)



* [Removing Satellite Config from your cluster](https://cloud.ibm.com/docs/satellite?topic=satellite-remove-satconfig)
* [Reviewing resources that are managed by Satellite Config](https://cloud.ibm.com/docs/satellite?topic=satellite-satcon-resources)



* Connecting Satellite locations with external services by using Link endpoints



* [Understanding Link endpoints and Satellite](https://cloud.ibm.com/docs/satellite?topic=satellite-link-location-cloud)
(https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) 







 Cluster service access roles 



Actions that you can take with service access roles.

 Action API CLI None Reader Writer Deployer Manager 

 Attach a cluster to Satellite Config. registerCluster [cluster register](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecli-cluster-register) ![Feature available.](https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) 
 Get a script to register a cluster to Satellite Config. enableRegistrationUrl [cluster register](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecli-cluster-register) ![Feature available.](https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) 
 Remove a cluster from Satellite Config. deleteCluster [cluster unregister](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecli-cluster-unregister) ![Feature available.](https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) 
 View clusters that are attached to Satellite Config.
Aggregations See [table](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-query-defaultsaggregations-dr) See [table](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-query-defaultsaggregations-dr-contracts) 
 autocomplete true true 
 fields_shown.body.field "" "" 
 fields_shown.body.use_passage true true 
 fields_shown.title.field "title" "title" 
 results_per_page 5 5 
 structured_search false false 







 Project component settings continued 

The Custom project type has no project component default settings.



Project component settings continued

 Default Conversational search Content Mining 

 Aggregations [] [] 
 autocomplete false true 
 fields_shown.body.field "" text 
 fields_shown.body.use_passage true false 
 fields_shown.title.field "title" "document_id" 
 results_per_page 0 0 
 structured_search false false 







 Document Retrieval project aggregations 



Document Retrieval project aggregations

 aggregations.name aggregations.label aggregations.multiple_selections_allowed 

 "name": "entities" "label": "Top Entities" "multiple_selections_allowed": false 
 "name": "_system_collections" "label": "Collections" "multiple_selections_allowed": true 







 Document Retrieval for Contracts project aggregations 



Document Retrieval for Contracts project aggregations

 aggregations.name aggregations.label aggregations.multiple_selections_allowed 

 "name": "categories" "label": "Category" "multiple_selections_allowed": true 
 "name": "natures" "label": "Nature" "multiple_selections_allowed": false 
 "name": "contract_terms" "label": "Contract Term" "multiple_selections_allowed": false 
 "name": "contract_payment_terms" "label": "Contract Payment Term" "multiple_selections_allowed": false
(https://cloud.ibm.com/docs/containers?topic=containers-strategyapp_kinds)
* [What about serverless apps?](https://cloud.ibm.com/docs/containers?topic=containers-strategyapps_serverless-strategy)
* [What skills should I have before I move my apps to a cluster?](https://cloud.ibm.com/docs/containers?topic=containers-strategyknowledge)



* [Sizing your Kubernetes cluster to support your workload](https://cloud.ibm.com/docs/containers?topic=containers-strategysizing)



* [How many resources does my app require?](https://cloud.ibm.com/docs/containers?topic=containers-strategysizing_resources)
* [What else besides my app might use resources in the cluster?](https://cloud.ibm.com/docs/containers?topic=containers-strategysizing_other)
* [What type of availability do I want my workload to have?](https://cloud.ibm.com/docs/containers?topic=containers-strategysizing_availability)
* [How many worker nodes do I need to handle my workload?](https://cloud.ibm.com/docs/containers?topic=containers-strategysizing_workers)
* [How do I monitor resource usage and capacity in my cluster?](https://cloud.ibm.com/docs/containers?topic=containers-strategysizing_manage)



* [Structuring your Kubernetes environment](https://cloud.ibm.com/docs/containers?topic=containers-strategykube_env)



* [What type of cluster and flavors should I get?](https://cloud.ibm.com/docs/containers?topic=containers-strategyenv_flavors)
* [Do I use multiple clusters, or just add more workers to an existing cluster?]
: The region that your cluster is in.

"cluster":"aa1a11a1a11b2b2bb22b22222c3c3333"
: The cluster ID that is associated with the storage instance.

"type":"Endurance"
: The type of file or block storage, either Endurance or Performance.

"ns":"default"
: The namespace that the storage instance is deployed to.

"pvc":"block-storage-pvc"
: The name of the PVC that is associated with the storage instance.

"pv":"pvc-d979977d-d79d-77d9-9d7d-d7d97ddd99d7"
: The PV that is associated with the storage instance.

"storageclass":"ibmc-file-gold"
: The type of storage class: bronze, silver, gold, or custom.
11. Remove the physical storage instance.

ibmcloud sl block volume-cancel <classic_block_id>
12. Verify that the physical storage instance is removed.



The deletion process might take up to 72 hours to complete.

ibmcloud sl block volume-list
Create the cluster with the following features.



* Classic clusters:



* Zone: Any [multizone-capable zone](https://cloud.ibm.com/docs/containers?topic=containers-regions-and-zoneszones-mz)
* Worker node flavor: Any classic infrastructure flavor
* Network connectivity: Public and private VLANs
* Worker pool: At least 2 worker nodes
* Version: 1.20.7 or later
* Cloud service endpoints: Both public and private endpoints
* Subnets: Include subnets in the --pod-subnet and --service-subnet options if the default ranges conflict with the Satellite location’s subnet that you set up in your on-premises data center or in a different cloud provider



* VPC clusters:



* Zone: Any [multizone-capable VPC zone](https://cloud.ibm.com/docs/containers?topic=containers-regions-and-zoneszones-vpc)
* Worker node flavor: Any VPC infrastructure flavor
* Version: 1.20.7 or later
* Worker pool: At least 2 worker nodes
* Subnets: Include subnets in the --pod-subnet and --service-subnet options if the default ranges conflict with the Satellite location’s subnet that you set up in your on-premises data center or in a different cloud provider
* Cloud service endpoints: Do not specify the --disable-public-service-endpoint option to ensure that both public and private endpoints are created





4. Spread the default worker pool across zones to increase the availability of your [classic](https://cloud.ibm.com/docs/containers?topic=containers-add_workersadd_zone) or [VPC](https://cloud.ibm.com/docs/containers?topic=containers-add_workersvpc_add_zone) cluster. Ensure that at least 2 worker nodes exist in each zone, so that the private ALBs that you configure in subsequent steps are highly available and can properly receive version updates.
5. Set the IBM Cloud Kubernetes Service cluster as the context for this session.
Use the attributes to refer to index groups by using a custom string value. If no values are supplied for these fields, they're automatically populated with a hash value.

If you create multiple text indexes in a database, with the same ddoc value, you need to know at least the ddoc value and the name value. Creating multiple indexes with the same ddoc value places them into the same design document. Generally, you must put each text index into its own design document.

For more information, see the [more about text indexes](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-note-about-text-indexes).

See the following example of a JSON document that requests a partitioned index creation:

{
"index": {
"fields": [
{
"name": "Movie_name",
"type": "string"
}
]
},
"name": "Movie_name-text",
"type": "text",
"partitioned": true
}

See the following example of JSON document that requests a global index creation:

{
"index": {
"fields": [
{
"name": "Movie_name",
"type": "string"
}
]
},
"name": "Movie_name-text",
"type": "text",
"partitioned": false
}

See the following example of a JSON document that requests creation of a more complex partitioned index:

{
"type": "text",
"name": "my-index",
"ddoc": "my-index-design-doc",
"index": {
"default_field": {
"enabled": true,
"analyzer": "german"
},
"selector": {},
"fields": [
{"name": "married", "type": "boolean"},
Deleting clusters from Cyber Recovery instances 

You can delete clusters from Cyber Recovery instances when you do not need them.



 Before you delete clusters from Cyber Recovery instances 



* Whenever possible, delete clusters by using the IBM Cloud® for VMware Solutions console and not the VMware vSphere® Web Client. Changes that you make on the vSphere Web Client are not synchronized with the VMware Solutions console. If you want to delete clusters from Cyber Recovery instances by using the vSphere Web Client, do so only for on-premises clusters or clusters that you don't manage in the VMware Solutions console.
* You can delete any cluster except for the first cluster (the one that is created during initial deployment).
* You can delete multiple clusters at a time. You can also delete a cluster while another cluster is being created or deleted.
* Ensure that all nodes in a cluster are powered on and operational before you delete the cluster.
* When you delete a cluster, all virtual machines (VMs) from the cluster are also deleted, and they can't be recovered. If you want to keep the VMs, migrate them to other clusters.
* You don't have to delete any services that are installed on a cluster. The services are automatically deleted when you delete the cluster.







 Procedure to delete clusters from Cyber Recovery instances 



1. From the IBM Cloud for VMware Solutions console, click Resources > Cyber Recovery from the left navigation pane.
2. In the Cyber Recovery table, click the instance that you want to delete clusters from.

Ensure that the instance status is Available. Otherwise, you can't delete clusters from the instance.
3. Click Infrastructure on the left navigation pane. In the Clusters table, locate the cluster that you want to delete and click the Delete icon ![Delete icon](https://cloud.ibm.com/docs-content/v1/content/5bdb37c0149145723c5437e8176651928565e722/icons/delete.svg) next to the Status column.
4.
Why can't I update or complete other actions with my cluster? 

  What’s happening 

When you try to manage your cluster, such as to perform a cluster update, the operation fails with a message similar to the following.

Cluster management is not currently available for this Satellite location. The location requires action to enable cluster operations. Please see logs for more detailed information.

  Why it’s happening 

Your Satellite location is currently in an unhealthy state, so cluster operations are blocked to prevent the operation from failing.

  How to fix it 

[Debug your location](https://cloud.ibm.com/docs/satellite?topic=satellite-ts-locations-debug), such as reviewing the platform logs and common error messages to find the reason for the unhealthy state.

When the location is healthy, you can resume managing your cluster.
To learn about activities and to handle them correctly with CBR rules, a test phase in reporting mode of at least a month is recommended. This allows for an iterative approach towards the desired set of network zones and context rules.

For this tutorial, we are going to define the following network zones:



* a zone for each of the deployed services which are supported as service reference for originating traffic
* a zone for each for the Kubernetes cluster
* for an IP range with the addresses of a home network (corporate or bastion) to serve as homezone
* a zone for each of the CBR-enabled platform services



Thereafter, we are going to define context rules as follows:



* for the access to the [Key Protect instance](https://cloud.ibm.com/docs/key-protect?topic=key-protect-access-control-with-cbr)
* for the access to the [Object Storage instance and its bucket](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-setting-a-firewall)
* for the access to the [Container Registry and the namespace with the container image](https://cloud.ibm.com/docs/Registry?topic=Registry-iamiam_cbr)
* for the access to the [Kubernetes Service cluster and its management API](https://cloud.ibm.com/docs/containers?topic=containers-cbrprotect-api-types-cbr)



All the above zones and rules can be deployed in either report-only or enforced mode with a single Terraform command. Note that the rules are not meant for production use, but as a sample to investigate usage and traffic in report-only mode.

The documentation has a [list of resources which are supported as service references](https://cloud.ibm.com/docs/account?topic=account-context-restrictions-whatisservice-attribute).
: If you use the CLI, you can specify the --service-instance CLUSTER-ID option to protect a specific cluster.
: If you use the API, you can specify "name": "serviceInstance","value": "CLUSTER-ID" in the resource attributes.

Region
: Protects Red Hat OpenShift on IBM Cloud resources in a specific region. If you select a region in your CBR rule, then only traffic from resources in the network zones that you associate with the rule can interact with resources in that region.
: If you use the CLI, you can specify the --region REGION option to protect resources in a specific region.
: If you use the API, you can specify "name": "region","value": "REGION" field in the resource attributes.

Resource group
: Protects Red Hat OpenShift on IBM Cloud resources in a specific resource group.
: If you use the CLI, you can specify the --resource-group-id RESOURCE-GROUP-ID option to protect resources in a specific resource group.
: If you use the API, you can specify "name": "resourceGroupId","value": "RESOURCE-GROUP-ID" field in the resource attributes.





 Protecting specific APIs 

You can create CBR rules to protect the following API types for Red Hat OpenShift on IBM Cloud.

Cluster control plane APIs
: Protect access to the APIs inside your clusters, such as the APIs for creating namespaces, pods, and more. CBR rules that apply to the cluster API type control access to your cluster API server, which includes all oc commands to that cluster. If you select the cluster control plane APIs in your CBR rule, then only traffic from resources in the network zones that associate with that rule can interact with the cluster control plane APIs. All other requests are blocked.
: If you use the CLI, you can specify the --api-types option and the crn:v1:bluemix:public:containers-kubernetes::::api-type:cluster type.
* [General ways to resolve cluster issues](https://cloud.ibm.com/docs/openshift?topic=openshift-get-helphelp-general)
* [Reviewing issues and status](https://cloud.ibm.com/docs/openshift?topic=openshift-get-helphelp-cloud-status)
* [Feedback and questions](https://cloud.ibm.com/docs/openshift?topic=openshift-get-helpfeedback-qs)
* [Contacting support](https://cloud.ibm.com/docs/openshift?topic=openshift-get-helphelp-support)
* [Requesting access to allowlisted features](https://cloud.ibm.com/docs/openshift?topic=openshift-get-helpallowlist-access-request)



[Running tests with the Diagnostics and Debug Tool](https://cloud.ibm.com/docs/openshift?topic=openshift-debug-tooldebug-tool)



* [Enabling the Diagnostics and Debug Tool add-on](https://cloud.ibm.com/docs/openshift?topic=openshift-debug-tooldebug-tool-enable)





 Clusters and masters 

[Debugging clusters](https://cloud.ibm.com/docs/openshift?topic=openshift-debug_clustersdebug_clusters)

[Debugging webhooks](https://cloud.ibm.com/docs/openshift?topic=openshift-ts-webhook-debugts-webhook-debug)



* [Reviewing the service that the webhook is calling](https://cloud.ibm.com/docs/openshift?topic=openshift-ts-webhook-debugreview-webhook-service)
* [ibmcloud sat resource](https://cloud.ibm.com/docs/satellite?topic=satellite-icsat_mapicsat_map_resource)
* [ibmcloud sat service](https://cloud.ibm.com/docs/satellite?topic=satellite-icsat_mapicsat_map_service)
* [ibmcloud sat storage](https://cloud.ibm.com/docs/satellite?topic=satellite-icsat_mapicsat_map_storage)
* [ibmcloud sat subscription](https://cloud.ibm.com/docs/satellite?topic=satellite-icsat_mapicsat_map_subscription)
* [ibmcloud sat messages](https://cloud.ibm.com/docs/satellite?topic=satellite-icsat_mapicsat_map_messages)



[CLI reference for Satellite commands](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencesatellite-cli-reference)



* [ibmcloud sat commands](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencesatellite-cli-map)
* [Cluster commands](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencesat-cluster-commands)



* [ibmcloud sat cluster get](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecli-cluster-get)
* [ibmcloud sat cluster ls](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecli-cluster-ls)
* [ibmcloud sat cluster register](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecli-cluster-register)
* Some IBM Cloud Kubernetes Service clusters that were created before 8 October 2022 are not able to enforce public CBR rules for the cluster's APIserver. To check if your cluster supports these public cluster API type CBR rules, run the ibmcloud ks cluster get -c <CLUSTER-ID> command. If either of the Service Endpoint URLs starts with the https://cXXX (where XXX is any three digit number), then the cluster does support public CBR rules. If the Service Endpoint URLs starts with https://cX (where the number after the c is a single digit), then the cluster is not able to enforce public CBR rules for the cluster's APIserver. To use public CBR rules, you must create a new cluster.