Skip to content

Commit

Permalink
chore: fix broken links for ngrok (#2965) (#2968)
Browse files Browse the repository at this point in the history
* chore: Fix broken links for Ngrok

* chore: Fix formatting in MetalLB

(cherry picked from commit 9da3d39)

Co-authored-by: Yuliia Horbenko <[email protected]>
  • Loading branch information
1 parent 0baae1d commit 96a1d0b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 35 deletions.
32 changes: 2 additions & 30 deletions docs/docs-content/integrations/metallb.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,6 @@ one is needed.
The _lb-metallb_ manifest-based pack supports direct configuration of an L2 IP address set. The _lb-metallb-helm_
Helm-based pack provides an L2 address pool.

<br />

### Manifest

Manifest-based MetalLB supports direct configuration of an L2 IP address set. You can set either a range of addresses or
Expand All @@ -62,8 +60,6 @@ use CIDR format, such as `192.168.250.48/29`. A more advanced MetalLB configurat

The example shows the syntax used to set an address range.

<br />

```yaml
manifests:
metallb:
Expand All @@ -76,8 +72,6 @@ manifests:
- 192.168.250.48-192.168.250.55
```
<br />
### Helm Chart
Helm-based MetalLB default gives you an L2 address pool by default. It has two sections,
Expand All @@ -87,8 +81,6 @@ Use the `charts:metallb-full:configuration` parameter section to set resource ty
default gives you an L2 address pool. To set up a more advanced scenario, you can use the other resource types provided
in the pack. The pack includes a commented-out example for each resource.

<br />

```yaml
charts:
metallb-full:
Expand All @@ -113,14 +105,10 @@ charts:
bfdprofiles: {}
```

<br />

The `charts:metallb-full:metallb` parameter section provides access to all the options of the base chart that installs
MetalLB. You don’t need to change anything unless you want to install MetalLB in Free Range Routing (FRR) mode. To use
FRR mode, set the option to `true`, as the example shows.

<br />

```yaml
charts:
metallb-full:
Expand Down Expand Up @@ -167,8 +155,6 @@ Gateway Protocol (BGP) routing requires you to write your own manifests and add

The example shows the syntax used to set an address range.

<br />

```yaml
manifests:
metallb:
Expand All @@ -195,8 +181,6 @@ advantage of new features.
</TabItem>
</Tabs>

<br />

## Troubleshooting

If controller and speaker pods are not assigning new IP addresses that you provided in the MetalLB pack, it is likely
Expand All @@ -207,32 +191,22 @@ The MetalLB controller and speakers use the configMap as a volume mount.

Any changed IP addresses will get updated in the configMap. You can confirm this by issuing the following command.

<br />

```bash
kubectl describe cm config --namespace metallb-system
```

<br />
Since the controller and speaker pods are using a previous copy of the configMap, existing deployments are unaware of the
changes made to configMap.

<br />
<br />
Since the controller and speaker pods are using a previous copy of the configMap, existing deployments are unaware of
the changes made to configMap.

To ensure updated addresses are reflected in the configMap, you need to restart the controller and speaker pods so they
fetch the new configMap and start assigning new addresses correctly. Issue the commands below to restart the controller
and speaker.

<br />

```bash
kubectl rollout restart deploy controller --namespace metallb-system
kubectl rollout restart ds speaker --namespace metallb-system
```

<br />

## Terraform

```hcl
Expand All @@ -246,8 +220,6 @@ data "spectrocloud_pack" "MetalLB-Helm" {
}
```

<br />

## References

- [MetalLB](https://metallb.universe.tf/)
Expand Down
7 changes: 2 additions & 5 deletions docs/docs-content/integrations/ngrok.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,8 @@ To deploy the ngrok Ingress Controller, you need to set, at minimum, the followi
| `kubernetes-ingress-controller.rules.host.backend.service.name` | The name you've given to the application for which the ngrok Ingress Controller should handle traffic. |
| `kubernetes-ingress-controller.rules.host.backend.service.port.number` | The port number for the deployed `service.name`. |

Review the
[common overrides](https://github.com/ngrok/kubernetes-ingress-controller/blob/main/docs/deployment-guide/common-helm-k8s-overrides.md)
document for more details on parameters. Refer to the
[user guide](https://github.com/ngrok/kubernetes-ingress-controller/tree/main/docs/user-guide) for advanced
configurations.
Review the [common overrides](https://ngrok.com/docs/k8s/deployment-guide/#common-helm-k8s-overrides) document for more
details on parameters. Refer to the [user guide](https://ngrok.com/docs/k8s/user-guide/) for advanced configurations.

:::warning

Expand Down

0 comments on commit 96a1d0b

Please sign in to comment.