vania-janet/multiturn-rag-retrieval-data huggingface dataset:
If you do not include this option, you must specify the --group or the --service-cluster-id option.

--group GROUP
: The ID of the cluster group. To list Satellite cluster groups, run ibmcloud sat group ls. To assign the storage configuration to multiple cluster groups at the same time, repeat this option. If you do not include this option, you must specify the --cluster or the --service-cluster-id option.

--service-cluster-id CLUSTER_ID
: The ID of a Satellite-enabled IBM Cloud service cluster. To find the cluster ID, run ibmcloud sat service ls --location <location>. If you do not include this option, you must specify the --cluster or the --group option.

--name NAME
: Optional. Enter a name for your storage assignment.

-q
: Optional. Do not show the message of the day or update reminders.





 Example 

ibmcloud sat storage assignment create --group staging --config file100 --name file100-staging







 ibmcloud sat storage assignment get 

Get the details of a Satellite storage assignment.

ibmcloud sat storage assignment get --assignment ASSIGNMENT



 Minimum required permissions 

IBM Cloud IAM Viewer platform role for the Resource resource in Satellite. For more information, see [Checking user permissions](https://cloud.ibm.com/docs/satellite?topic=satellite-iam-assign-accesschecking-perms).





 Command options 

--assignment ASSIGNMENT
: Required. The name of the storage assignment. To list Satellite storage configurations, run ibmcloud sat storage assignment ls.

--output json
: Optional. Prints the command output in JSON format.

-q
: Optional. Do not show the message of the day or update reminders.





 Example 

ibmcloud sat storage assignment get --assignment my-assignment







 ibmcloud sat storage assignment ls 

List your Satellite storage assignments.
Resource type: cluster Resource type: topic Resource ID: <name_of_topic> Not applicable 
 Allow an app to connect and consume from any topic (no consumer group). Resource type: cluster <br>Resource type: topic Not applicable Not applicable 
 Allow an app to connect and consume from a specific topic (no consumer group). Resource type: cluster Resource type: topic Resource ID: <name_of_topic> Not applicable Not applicable 
 Allow an app to consume a topic (consumer group). Resource type: cluster <br>Resource type: topic <br>Resource type: group Not applicable Not applicable 
 Allow an app to produce to a topic transactionally. Resource type: cluster Resource type: group Resource type: topic Resource ID: <name_of_topic> Resource type: txnid Not applicable 
 Delete consumer group. Resource type: cluster Not applicable Resource type: group Resource ID: <group_ID> 
 To use Streams. Resource type: cluster <br>Resource type: group Not applicable Resource type: topic 
 Delete records. Not applicable Not applicable Resource type: topic Resource ID: <name_of_topic> 



For more information about IAM, see [IBM Cloud Identity and Access Management](https://cloud.ibm.com/docs/account?topic=account-iamoverview).

For an example of how to set policies, see [IBM Cloud IAM Service IDs and API Keys](https://www.ibm.com/cloud/blog/introducing-ibm-cloud-iam-service-ids-api-keys).





 Wildcarding 

You can take advantage of the IAM wildcarding facility to set policies for groups of resources on Event Streams. For example, if you give all your topics names like Dept1_Topic1 and Dept1_Topic2, you can set policies for topics that are called Dept1_* and these policies are applied to all topics with that prefix. For more information, see [Assigning access by using wildcard policies](https://cloud.ibm.com/docs/account?topic=account-wildcard).





 Connecting to Event Streams
set chassis cluster redundancy-group 0 node 0 priority 100
set chassis cluster redundancy-group 0 node 1 priority 1
set chassis cluster redundancy-group 1 node 1 priority 1
set chassis cluster redundancy-group 1 node 0 priority 100
set chassis cluster redundancy-group 1 preempt
set security log mode stream
set security log report
set security address-book global address SL1 10.0.64.0/19
set security address-book global address SL2 10.1.128.0/19
set security address-book global address SL3 10.0.86.0/24
set security address-book global address SL4 10.2.128.0/20
set security address-book global address SL5 10.1.176.0/20
set security address-book global address SL6 10.1.64.0/19
set security address-book global address SL7 10.1.96.0/19
set security address-book global address SL8 10.1.192.0/20
set security address-book global address SL9 10.1.160.0/20
set security address-book global address SL10 10.2.32.0/20
set security address-book global address SL11 10.2.64.0/20
set security address-book global address SL12 10.2.112.0/20
set security address-book global address SL13 10.2.160.0/20
set security address-book global address SL14 10.1.208.0/20
set security address-book global address SL15 10.2.80.0/20
set security address-book global address SL16 10.2.144.0/20
set security address-book global address SL17 10.2.48.0/20
set security address-book global address SL18 10.2.176.0/20
set security address-book global address SL19 10.3.64.0/20
set security address-book global address SL20 10.3.80.0/20
set security address-book global address SL_PRIV_MGMT 10.135.70.22/32
: Required: The name or ID of the cluster.

-f
: Optional: Force the command to run with no user prompts.

-q
: Optional: Do not show the message of the day or update reminders.



 Example cluster image-security enable command 

ibmcloud ks cluster image-security enable --cluster my_cluster







 ibmcloud ks cluster ls 

Virtual Private Cloud

Classic infrastructure

Satellite

List all clusters in your IBM Cloud account.

Clusters in all locations are returned. To filter clusters by a specific location, include the --location option. For example, if you filter clusters for the dal metro, multizone clusters in that metro and single-zone clusters in data centers (zones) within that metro are returned. If you filter clusters for the dal10 data center (zone), multizone clusters that have a worker node in that zone and single-zone clusters in that zone are returned. You can pass one location or a comma-separated list of locations.

ibmcloud ks cluster ls [--provider (classic | vpc-gen2)] [--location LOCATION] [--output json] [-q]

Minimum required permissions
: Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--provider (classic | vpc-gen2)
: Optional: Filter output based on infrastructure provider type.

-l, --location LOCATION
: Filter output by a specific location. To see supported locations, run ibmcloud ks locations. To specify multiple locations, use one option for each location, such as -l dal -l seo.

--output json
: Optional: Prints the command output in JSON format. Note: If you don't include the --provider option, only classic clusters are returned.

-q
: Optional: Do not show the message of the day or update reminders.



 Example cluster ls command 

ibmcloud ks cluster ls -l ams03 -l wdc -l ap







 ibmcloud ks cluster master audit-webhook 

Modify the webhook back end that forwards API server audit logs to a remote server.
| Exists | title: || \]Link 11]! ! ! ! ! | Does not exist | title: |<-- </table ""> --><-- </section "id="section-operators" "> --><-- <section "id="section-aggregations" "> --> Aggregations Aggregations return a set of data values. These are the available aggregations:<-- <table> -->| Aggregation | Description | Example ||:-----------------------------:|:---------------------------------------------------------- |:----------------------------------------------------- || term]] | Count of identical values | term(enriched_text.concepts.text,count:10) || filter]filter 1] | Filter results set to defined pattern | filter(enriched_text.concepts.text:cloud computing) || nested]] | Restrict aggregation | nested(enriched_text.entities) || histogram]] | Interval based distribution | histogram(product.price,interval:1) || timeslice]] | Time base distribution | timeslice(last_modified,2day,America/New York) || top_hits]top_hits] | Top ranked results documents for the current aggregation | term(enriched_text.concepts.text).top_hits(10) || unique_count]unique_count] | Count of unique values for a field within an aggregation | unique_count(enriched_text.entities.type) || max]] | Maximum value for the specified field in the results set. | max(product.price) || min]] | Minimum value for the specified field in the results set.
addGroup [cluster-group create](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-create) ![Feature available.](https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) 
 View cluster groups that are attached to Satellite Config. groups [cluster-group ls](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-ls) <br>[cluster-group get](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-get) ![Feature available.](https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) ![Feature available.](https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) 
 Remove a cluster group. removeGroup [cluster-group rm](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-rm) ![Feature available.](https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) 







 Resources service access roles
Verifying cluster status 

After you set up your clusters to use with Satellite Config, verify the status of your clusters to make sure Satellite Config can deploy resources to them.

You can view your cluster's status on the Satellite [Clusters](https://cloud.ibm.com/satellite/clusters) dashboard.



Satellite Config cluster status

 Cluster status  Description                                                                                                                                                                      

 Registered      The cluster is registered. You must apply the attach script and wait for the cluster status to change to Active before you can deploy resources to this cluster.                 
 Active          You can start deploying resources to this cluster.                                                                                                                               
 Inactive        The cluster cannot communicate with the backend API for more than one hour and is flagged as Inactive. You must fix the errors on the cluster before it can be active again.
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. clusters calls [cluster ls](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecli-cluster-ls) <br>[cluster get](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecli-cluster-get) ![Feature available.](https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) ![Feature available.](https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) 







 Cluster group service access roles 



Actions that you can take with service access roles.

 Action API CLI None Reader Writer Deployer Manager 

 Add clusters to a cluster group. groupClusters [cluster-group attach](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-attach) ![Feature available.]
: You can organize your account resources in customizable groupings so that you can quickly assign individual or groups of users access to more than one resource at a time. Resource groups can help operators and administrators filter resources to view their current usage, troubleshoot issues, and manage teams.
: A cluster can be created in only one resource group that you can't change afterward. If you create a cluster in the wrong resource group, you must delete the cluster and re-create it in the correct resource group. Furthermore, if you need to use the ibmcloud ks cluster service bind command to [integrate with an IBM Cloud service](https://cloud.ibm.com/docs/containers?topic=containers-service-bindingbind-services), that service must be in the same resource group as the cluster. Services that don't use resource groups like IBM Cloud Container Registry or that don't need service binding like IBM Log Analysis work even if the cluster is in a different resource group.
: 

* Consider giving clusters unique names across resource groups and regions in your account to avoid naming conflicts. You can't rename a cluster.
* You can assign users an access role to a resource group to grant permissions as described in the following scenarios. Note that unlike resource instances, you can't grant access to an individual instance within a resource group.
* All IBM Cloud IAM services in the resource group, including all clusters in IBM Cloud Kubernetes Service and images in IBM Cloud Container Registry.
* All instances within a service in the resource group, such as all the clusters in IBM Cloud Kubernetes Service.
* All instances within a region of a service in the resource group, such as all the clusters in the US South region of IBM Cloud Kubernetes Service.
- If the cluster name is 26 characters or fewer and the cluster name is unique in this region, the entire cluster name is included and is not modified: myclustername.<br><br><br><br> * If the cluster name is 26 characters or fewer and there is an existing cluster of the same name in this region, the entire cluster name is included and a dash with six random characters is added: myclustername-ABC123.<br> * If the cluster name is 26 characters or greater and the cluster name is unique in this region, only the first 24 characters of the cluster name are used: myveryverylongclusternam.<br> * If the cluster name is 26 characters or greater and there is an existing cluster of the same name in this region, only the first 17 characters of the cluster name are used and a dash with six random characters is added: myveryverylongclu-ABC123.<br><br><br> 
 <globally_unique_account_HASH> A globally unique HASH is created for your IBM Cloud account. All subdomains that you create for NLBs in clusters in your account use this globally unique HASH. 
 0001 The first and second characters indicate a public or a private (internal) subdomain. - 00 indicates a subdomain that has a public DNS entry.<br><br><br><br> * i0 indicates a subdomain that has a private DNS entry.<br> * The first and second characters, 00, indicate a public subdomain.<br> * The third and fourth characters, such as 01 or another number, act as a counter for each subdomain that you create.<br><br><br> 
 <region> The region that the cluster is created in. 
 containers.appdomain.cloud The subdomain for IBM Cloud Kubernetes Service subdomains. 







 Enable health checks on a subdomain by creating a health monitor 

Enable health checks on the NLB IP addresses behind a single subdomain to determine whether they are available or not.
* [Comparison of free and standard clusters](https://cloud.ibm.com/docs/containers?topic=containers-cs_ovcluster_types)
* [Comparison between Red Hat OpenShift and community Kubernetes clusters](https://cloud.ibm.com/docs/containers?topic=containers-cs_ovopenshift_kubernetes)



[Supported infrastructure providers](https://cloud.ibm.com/docs/containers?topic=containers-infrastructure_providersinfrastructure_providers)



* [Virtual Private Cloud (VPC)](https://cloud.ibm.com/docs/containers?topic=containers-infrastructure_providersvpc-gen2-infra-overview)
* [Classic](https://cloud.ibm.com/docs/containers?topic=containers-infrastructure_providersclassic-infra-overview)
* [Troubleshooting and support](https://cloud.ibm.com/docs/containers?topic=containers-infrastructure_providersinfra-troubleshoot)



[Your responsibilities with using IBM Cloud Kubernetes Service](https://cloud.ibm.com/docs/containers?topic=containers-responsibilities_iksresponsibilities_iks)



* [Overview of shared responsibilities](https://cloud.ibm.com/docs/containers?topic=containers-responsibilities_iksoverview-by-resource)
* [Tasks for shared responsibilities by area](https://cloud.ibm.com/docs/containers?topic=containers-responsibilities_ikstask-responsibilities)



* [Incident and operations management](https://cloud.ibm.com/docs/containers?topic=containers-responsibilities_iksincident-and-ops)
* [Change management](https://cloud.ibm.com/docs/containers?topic=containers-responsibilities_ikschange-management)
* [Identity and access management](https://cloud.ibm.com/docs/containers?topic=containers-responsibilities_iksiam-responsibilities)
Learning path for administrators 

Following a curated learning path through IBM Cloud® Kubernetes Service to create a cluster, manage the cluster's resources and lifecycle, and use the powerful tools of IBM Cloud Kubernetes Service to secure, manage, and monitor your cluster workloads.



 Plan your environment 

Start by designing a cluster for maximum availability and capacity for your workloads.



1. Environment strategy:



1. Define your [Kubernetes strategy](https://cloud.ibm.com/docs/containers?topic=containers-strategy) for the cluster, such as deciding how many clusters to create for your environments.
2. Plan your [security strategy](https://cloud.ibm.com/docs/containers?topic=containers-securitynetwork_segmentation), such as ensuring network segmentation and workload isolation.



2. Cluster setup: After you plan your environment, plan the setup for a specific cluster.



1. Choose a [supported infrastructure provider](https://cloud.ibm.com/docs/containers?topic=containers-infrastructure_providers).
2. Plan your [cluster network setup](https://cloud.ibm.com/docs/containers?topic=containers-plan_clusters).
3. Plan your cluster for [high availability](https://cloud.ibm.com/docs/containers?topic=containers-ha_clusters).
4. Plan your [worker node setup](https://cloud.ibm.com/docs/containers?topic=containers-planning_worker_nodes).





Looking for serverless? Try [Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-getting-started).





 Create a cluster 

Create a cluster with infrastructure, network, and availability setups that are customized to your use case and cloud environment.



1.
* Cluster / Namespace Available Resources
* Cluster Overview
* CPU Allocation Optimization
* Memory Allocation Optimization



Zoom

![Advisor predefined dashboards by cluster](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/overview-tab-clusters.png)

Advisor predefined dashboards by cluster

For more information on how to interpret this view, see [About Clusters Overview](https://docs.sysdig.com/en/docs/sysdig-monitor/advisor/overview/clusters-data/).





 Monitoring Kubernetes clusters by node 

When you choose to monitor your Kubernetes clusters by node, you can choose any of the following dashboards:



* Node Status & Performance
* Pod Scheduling Troubleshooting
* Node Overview
* CPU Allocation Optimization
* Memory Allocation Optimization



For more information on how to interpret this view, see [About Nodes Overview](https://docs.sysdig.com/en/docs/sysdig-monitor/advisor/overview/nodes-data/).





 Monitoring Kubernetes clusters by namespace 

When you choose to monitor your Kubernetes clusters by namespace, you can select more filters to display data by workload, or you can choose any of the following dashboards:



* Workload Status & Performance
* Pod Status & Performance
* Pod Rightsizing & Workload Capacity Optimization
* Namespace Overview
* Workloads CPU Usage and Allocation
* Workloads Memory Usage and Allocation



For more information on how to interpret this view, see [About Namespaces Overview](https://docs.sysdig.com/en/docs/sysdig-monitor/advisor/overview/namespaces-data/).





 Monitoring Kubernetes clusters by workloads 

When you choose to monitor your Kubernetes clusters by workloads, you can choose any of the following dashboards:



* Container Resource Usage & Troubleshooting
* Pod Status & Performance
[Setting up cluster groups](https://cloud.ibm.com/docs/satellite?topic=satellite-setup-clusters-satconfig-groupssetup-clusters-satconfig-groups)

[Registering clusters with Satellite Config](https://cloud.ibm.com/docs/satellite?topic=satellite-register-openshift-clustersregister-openshift-clusters)

[Verifying cluster status](https://cloud.ibm.com/docs/satellite?topic=satellite-satconfig-verify-cluster-statussatconfig-verify-cluster-status)

[Syncing subscription identity](https://cloud.ibm.com/docs/satellite?topic=satellite-sat-sync-sub-identitysat-sync-sub-identity)





 Creating and managing Satellite configurations 

[Managing GitOps configurations](https://cloud.ibm.com/docs/satellite?topic=satellite-satcon-manage-gitopssatcon-manage-gitops)



* [Creating Satellite configurations](https://cloud.ibm.com/docs/satellite?topic=satellite-satcon-manage-gitopssatcon-create-gitops)



* [Creating a secret for using a private repository](https://cloud.ibm.com/docs/satellite?topic=satellite-satcon-manage-gitopscreate-satconfig-private-secret)
* [Creating Satellite configurations from the console](https://cloud.ibm.com/docs/satellite?topic=satellite-satcon-manage-gitopscreate-satconfig-ui-gitops)
* [Creating Satellite configurations from the CLI](https://cloud.ibm.com/docs/satellite?topic=satellite-satcon-manage-gitopscreate-satconfig-cli-gitops)



* [Updating your Satellite configuration](https://cloud.ibm.com/docs/satellite?topic=satellite-satcon-manage-gitopssatcon-manage-update-gitops)
These are the available aggregations:<-- <table> -->| Aggregation | Description | Example ||:-----------------------------:|:---------------------------------------------------------- |:----------------------------------------------------- || term]] | Count of identical values | term(enriched_text.concepts.text,count:10) || filter]filter 1] | Filter results set to defined pattern | filter(enriched_text.concepts.text:cloud computing) || nested]] | Restrict aggregation | nested(enriched_text.entities) || histogram]] | Interval based distribution | histogram(product.price,interval:1) || timeslice]] | Time base distribution | timeslice(last_modified,2day,America/New York) || top_hits]top_hits] | Top ranked results documents for the current aggregation | term(enriched_text.concepts.text).top_hits(10) || unique_count]unique_count] | Count of unique values for a field within an aggregation | unique_count(enriched_text.entities.type) || max]] | Maximum value for the specified field in the results set. | max(product.price) || min]] | Minimum value for the specified field in the results set. | min(product.price) || average]] | Mean value for the specified field in the results set. | average(product.price) || sum]] ! ! ! ! !