chinmoysahu commented on code in PR #815: URL: https://github.com/apache/solr-operator/pull/815#discussion_r3355864982
########## docs/solr-cloud/gateway-api.md: ########## @@ -0,0 +1,264 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + +# Gateway API + +## Overview + +The Solr Operator supports using the [Kubernetes Gateway API](https://gateway-api.sigs.k8s.io/) for external addressability of SolrClouds. +Gateway API is a vendor-neutral, Kubernetes-native API for managing ingress traffic and is the successor to the Ingress API. + +When you configure `spec.solrAddressability.external.method: Gateway`, the Solr Operator creates and manages HTTPRoute resources +that route external traffic to your Solr nodes through an existing Gateway resource in your cluster. + +## What Gets Created + +When Gateway mode is enabled, the Solr Operator automatically creates the following Kubernetes resources: + +### HTTPRoute Resources + +The operator creates HTTPRoute resources to route traffic to Solr: + +- **Common HTTPRoute**: Routes traffic to the common Solr service (load-balanced across all nodes) + - Named: `<solrcloud-name>-solrcloud-common` + - Hostname: `<namespace>-<solrcloud-name>-solrcloud.<domainName>` + +- **Per-Node HTTPRoutes**: Routes traffic directly to individual Solr nodes (when `hideNodes: false`) + - Named: `<solrcloud-name>-solrcloud-<node-index>` + - Hostname: `<namespace>-<solrcloud-name>-solrcloud-<node-index>.<domainName>` + +All HTTPRoutes are owned by the SolrCloud resource and will be automatically cleaned up when the SolrCloud is deleted. + +### Services + +The same services are created as with other external addressability methods: +- Common service (load-balanced) +- Headless service (for internal cluster communication) +- Per-node services (when individual node access is enabled) Review Comment: done -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
