Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(data catalog): add head routes #1875

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

flower-of-the-bridges
Copy link
Member

Description

This PR updates the documentation to include HEAD routes for Control Plane and Data Catalog

Pull Request Type

  • Documentation content changes
  • Bugfix / Missing Redirects
  • Docusaurus site code changes

PR Checklist

  • The commit message follows our guidelines included in the CONTRIBUTING.md
  • All tests of Lint, cspell and check-content pass. (How to launch them?)
  • No sensitive content has been committed

Other information

@flower-of-the-bridges flower-of-the-bridges requested a review from a team as a code owner December 30, 2024 17:14
@github-actions github-actions bot added the fast-data Contents related to Mia-Platform Fast Data documentation label Dec 30, 2024
docs/data_catalog/data_catalog_fabric_bff.mdx Outdated Show resolved Hide resolved
Comment on lines +201 to +202
| `/grpc.reflection.v1.ServerReflection` | `/grpc.reflection.v1.ServerReflection` | `control-plane` | `50051` |
| `/grpc.reflection.v1alpha.ServerReflection` | `/grpc.reflection.v1alpha.ServerReflection` | `control-plane` | `50051` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it correct to expose these endpoints?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, they are needed to let control plane operator reach the control plane

@@ -168,29 +168,6 @@ necessary to apply any further configuration. If in doubt, please contact your K
In case Control Plane service should be configured to be reachable from outside your cluster, for example because your Fast Data Control Plane application is located in a cluster
different from the one where Fast Data Runtimes are deployed, a few extra advanced configuration steps are necessary. These are listed here:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Introduce further Envoy [`cluster`](https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto) to expose the gRPC port of Control Plane service through the API Gateway.**
This can be obtained by opening your Mia-Platform Console Project and selecting the Advanced tab from the Design area's sidebar.
:::info
This step is necessary if you are using Mia-Platform Console versions lower than v13.5.1. Otherwise, you can skip the modification to the file `api-gateway-envoy/clusters.yaml` here described.
:::
Within this area of Console it is possible
to extend Envoy API Gateway default configuration, by editing the file `api-gateway-envoy/clusters.yaml` with the following content:
```yaml title=api-gateway-envoy/clusters.yaml
- "@type": type.googleapis.com/envoy.config.cluster.v3.Cluster
name: control-plane
connect_timeout: 30s
http2_protocol_options:
max_concurrent_streams: 100
type: LOGICAL_DNS
lb_policy: ROUND_ROBIN
load_assignment:
cluster_name: control-plane
endpoints:
- lb_endpoints:
- endpoint:
address:
socket_address:
address: 'control-plane'
port_value: 50051

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fast-data Contents related to Mia-Platform Fast Data documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants