Skip to content

Add missing steps to "Your first service" + minor textual improvements #1135

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

schrnz
Copy link

@schrnz schrnz commented May 18, 2025

While playing around with automating a basic ziti deployment, I realized that two steps were missing in the "Your first service" page that otherwise serves as a great starting point:
The fact that services and identities need to be connected to routers via policies was neither mentioned on this page, nor on the previous ones in the quick start (unless I overlooked sth).
So my suggestion is to use the recommendation that's used in other parts of the docs: start with "allow all" policies for starters and refine later if needed.

The PR also contains some fixes for typos/textual improvements on the side.

First time doing a PR for ziti (and not a regular contributor on GitHub), so pls let me know if there is sth. else (besides the CLA) I should take care of.

@schrnz schrnz requested review from a team as code owners May 18, 2025 18:28
Copy link

vercel bot commented May 18, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
ziti-doc ✅ Ready (Inspect) Visit Preview May 21, 2025 4:25pm

@dovholuknf
Copy link
Member

Hi @schrnz, thanks for the PR. Is it possible for you toconfigure "commit signing"? Our project does require that all commits are signed. It's somewhat tedious to do, but it's a "once you do it you're done" sort of thing. :)

Also, did you use a deployment to run your overlay? If so, I think that's going to be the disconnect here. Could you confirm the method you used to start your overlay was using the 'deployment' guide (and not a quickstart)?

@schrnz
Copy link
Author

schrnz commented May 21, 2025

Hi @dovholuknf ,
sure no problem, force-pushed a signed version.

I can confirm I did not use a quickstart network. I read through the docs and setup everything on my own. By automating I meant the whole network setup was done using ansible. Sorry for the confusion...

@dovholuknf
Copy link
Member

Thanks for updating to signed commits! I didn't review the content fully before but I will now. Knowing that you did it manually on your own helps. I think that will just mean the new steps you added will be a "if necessary, do this" type of thing because the quickstarts will perform those steps for you. I don't recall if the 'deployment'-based install does but I'll test that out to see if it's relevant to our install flows or if it was just soemthing you missed in your ansible-based approach.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants