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

docs: TLS and DNS Policy user guides #322

Merged
merged 4 commits into from
Nov 28, 2023

Conversation

mikenairn
Copy link
Member

@mikenairn mikenairn commented Nov 21, 2023

Add user guide documentation for TLS and DNS Policy focused on the single cluster context and using the simple routing strategy for DNS.

To support the DNS and TLS policy guides, updates were made to install and configure, metallb and the policy controller:

  • Add script to generate MetalLB IPAddressPool for docker network nad execute as part of make install-metallb
./utils/docker-network-ipaddresspool.sh <docker network name> | kubectl apply -n metallb-system -f -
  • Expose port 80 and port 443 of the kind cluster so you can access it locally

@mikenairn mikenairn requested a review from a team as a code owner November 21, 2023 09:19
Copy link

codecov bot commented Nov 21, 2023

Codecov Report

Merging #322 (ec4e25a) into main (5fc58e4) will increase coverage by 0.68%.
Report is 2 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #322      +/-   ##
==========================================
+ Coverage   64.28%   64.97%   +0.68%     
==========================================
  Files          35       35              
  Lines        3794     3794              
==========================================
+ Hits         2439     2465      +26     
+ Misses       1158     1131      -27     
- Partials      197      198       +1     
Flag Coverage Δ
integration 69.79% <ø> (+0.14%) ⬆️
unit 59.50% <ø> (+1.29%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
api/v1beta1 (u) ∅ <ø> (∅)
pkg/common (u) 76.92% <ø> (+2.99%) ⬆️
pkg/istio (u) 30.24% <ø> (ø)
pkg/log (u) 31.81% <ø> (ø)
pkg/reconcilers (u) 33.68% <ø> (ø)
pkg/rlptools (u) 56.46% <ø> (ø)
controllers (i) 69.79% <ø> (+0.14%) ⬆️

see 3 files with indirect coverage changes

@@ -4,9 +4,14 @@ apiVersion: kind.x-k8s.io/v1alpha4
nodes:
- role: control-plane
image: kindest/node:v1.27.3
# port forward 80 on the host to 80 on this node
extraPortMappings:
- containerPort: 30950
hostPort: 9080
- containerPort: 30951
hostPort: 9443
Copy link
Member Author

Choose a reason for hiding this comment

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

If we decide to use metalb in the default setup we can probably drop these ports and use 9080 -> 80, 9443 -> 443

Copy link
Collaborator

@maleck13 maleck13 left a comment

Choose a reason for hiding this comment

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

docs look ok, I tihnk it would be good to pull out the common setup stuff and keep each doc just focused on the task, that way if you move from one to the other you can just get on with it.
Also we need to change the ref version in Gateways to be v1

@mikenairn mikenairn force-pushed the tls_and_dns_guide_docs branch from aac54d8 to f0b9534 Compare November 24, 2023 12:24
* Add deploy-policy-controller and undeploy-policy-controller,
  deploys/undeploys the policy-controller into/from the kuadrant-system
namespace.
* Update dns and tls guides with extra step to install
  policy-controller.
@mikenairn mikenairn force-pushed the tls_and_dns_guide_docs branch from f0b9534 to e9504db Compare November 24, 2023 12:29
Copy link
Collaborator

@maleck13 maleck13 left a comment

Choose a reason for hiding this comment

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

/lgtm

@maleck13
Copy link
Collaborator

@mikenairn the issue is with the 8080 port in the tests

@mikenairn
Copy link
Member Author

@mikenairn the issue is with the 8080 port in the tests

Yeah sure, 8080 was probably a bad choice

Copy link
Collaborator

@maleck13 maleck13 left a comment

Choose a reason for hiding this comment

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

went through all the steps. Worked as expected. Once we have a single cluster quick start then we prob want to drop some of these steps but this is good for now.

@maleck13 maleck13 merged commit b736a7b into Kuadrant:main Nov 28, 2023
15 checks passed
@mikenairn mikenairn deleted the tls_and_dns_guide_docs branch November 28, 2023 09:27
@alexsnaps alexsnaps added this to the v0.6.0 milestone Dec 8, 2023
maleck13 pushed a commit to maleck13/kuadrant-operator that referenced this pull request Dec 12, 2023
* docs: TLS and DNS Policy user guides

* docs: Update after removal of policy-controller from bundle

* Add deploy-policy-controller and undeploy-policy-controller,
  deploys/undeploys the policy-controller into/from the kuadrant-system
namespace.
* Update dns and tls guides with extra step to install
  policy-controller.

* Add script to generate MetalLB IPAddressPool for docker network.

* Change kind cluster ports 80 -> 9081, 443 -> 9444
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/doc Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants