Skip to content

Commit

Permalink
versioning and docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
justinthelaw committed Sep 27, 2024
1 parent 0840a69 commit d481b7f
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 11 deletions.
4 changes: 3 additions & 1 deletion chart/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,6 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.2.0
# x-release-please-start-version
version: 0.9.0
# x-release-please-end
6 changes: 3 additions & 3 deletions docs/DNS.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
## Domain Assumptions
# Domain Assumptions

One of the core assumptions of the `uds-k3d` package is the use of `uds.dev` as the base domain for your development environment. This assumption is integral to the DNS and network configuration provided by the package. It is based on an existing DNS entry for `*.uds.dev` that resolves to `127.0.0.1`, facilitating local development and testing.

### CoreDNS Override
## CoreDNS Override

[UDS Core](https://github.com/defenseunicorns/uds-core) is assumed to be the main infrastructure and/or testing target in local development; therefore, the DNS resolution assumes the existence of the default admin and tenant Istio gateways.

This package includes a CoreDNS configuration override designed to rewrite requests for `*.uds.dev` to the tenant and admin Istio gateways based on the subdomain, `*.admin.uds.dev` or `*.uds.dev`. This rewrite ensures that any DNS resolution request within the cluster targeting a `*.uds.dev` address will be correctly routed to the correct service mesh gateway.

The outcome of this is a pods in the cluster can resolve domains like sso.uds.dev to an address (not 127.0.0.1) that will ultimately get routed correctly.

### Nginx Configuration
## Nginx Configuration

Additionally, the package includes Nginx configuration that assumes the use of `uds.dev` as the base domain. This configuration is tailored to support the development environment setup, ensuring that Nginx correctly handles requests and routes them within the cluster, based on the `uds.dev` domain.
10 changes: 5 additions & 5 deletions docs/PORTS.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
## Port Configuration
# Port Configuration

By default, `uds-k3d` will only expose ports `80` and `443` through `k3d` with a redirect from `80` to `443` within the Nginx configuration. The works for most packages however some may require additional TCP ports to be opened in order to provide / test all of their functionality. To do so you can override the following:

### K3d Override
## K3d Override

First set (or add to) `K3D_EXTRA_ARGS` to include all of the ports that you would like to expose:

```
```bash
--set K3D_EXTRA_ARGS="-p <port>:<port>@server:* -p 9999:9999@server:*"
```

### Nginx Configuration
## Nginx Configuration

Then allow the ports to pass through Nginx by setting `NGINX_EXTRA_PORTS`:

```
```bash
--set NGINX_EXTRA_PORTS="[<port>,9999]"
```

Expand Down
2 changes: 1 addition & 1 deletion release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
{ "type": "chore", "section": "Miscellaneous", "hidden": false }
],
"versioning": "default",
"extra-files": ["README.md", "zarf.yaml"]
"extra-files": ["README.md", "zarf.yaml", "chart/Chart.yaml"]
}
}
}
4 changes: 3 additions & 1 deletion zarf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,9 @@ components:
- name: uds-dev-stack
namespace: uds-dev-stack
localPath: chart
version: 0.2.0
# x-release-please-start-version
version: 0.9.0
# x-release-please-end
valuesFiles:
- "values/dev-stack-values.yaml"
variables:
Expand Down

0 comments on commit d481b7f

Please sign in to comment.