Skip to content

docs: Update quick-start#13927

Merged
mattklein123 merged 23 commits intoenvoyproxy:masterfrom
phlax:docs-update-quickstart-running
Nov 10, 2020
Merged

docs: Update quick-start#13927
mattklein123 merged 23 commits intoenvoyproxy:masterfrom
phlax:docs-update-quickstart-running

Conversation

@phlax
Copy link
Copy Markdown
Member

@phlax phlax commented Nov 6, 2020

Signed-off-by: Ryan Northey ryan@synca.io

Commit Message: docs: Update quick-start running envoy page
Additional Description:

add info to running envoy page about:

  • validation mode
  • logging and debugging

minor updates to securing envoy page (#13880 (comment))

add section re web ui to admin page

Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Deprecated:]

Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax marked this pull request as draft November 6, 2020 15:44
phlax added 3 commits November 8, 2020 11:33
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
- critical
- off

You can also set the log level for specific components using the :option:`--component-log-level` option.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

it would be great if there were a way to dump the component list without having to read the header file.

perhaps we could add something along the lines of

envoy --mode dump --dump components

potentially it could also do a config_dump type thing where it tells you what would be configured

just an idea, not sure if i should raise a ticket

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah I agree this would be nice. Can you open a ticket to track this?

phlax added 2 commits November 8, 2020 17:54
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
phlax added 4 commits November 9, 2020 18:33
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax changed the title [WIP] docs: Update quick-start running envoy page [WIP] docs: Update quick-start Nov 10, 2020
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>

If you are running Envoy on a Windows system Envoy will output to ``CON`` by default.

This can also be used as a logging path when configuring logging.
Copy link
Copy Markdown
Member Author

@phlax phlax Nov 10, 2020

Choose a reason for hiding this comment

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

@envoyproxy/windows-dev can you confirm the above note about logging with windows is correct ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

While stdout will generally refer to CON, that depends on how the envoy process is launched... I'd point out that on windows, logs will default to stdout, and that the Linux /dev/stdout and /dev/stderr filename aliases to FD 1&2 don't exist. The NUL filename on windows can be used in place of /dev/null

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@wrowe can i land this and then someone with better knowledge could PR with some windows-specific updates ?

there are quite a few places where the docs are posix-focused - im just aware that this config wont work (and not sure what would)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We can give you further feedback later this morning. In the posix world, the file - name universally represents FD 1 (or FD 0 in the context of an input name). /dev/stdout is actually a newer convention. We need to decide as porters if we will implement the aliases /dev/null, /dev/stdout etc, or whether envoy should have unambiguous, non-os specific implementations of these things.

Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax changed the title [WIP] docs: Update quick-start docs: Update quick-start Nov 10, 2020
@phlax phlax marked this pull request as ready for review November 10, 2020 13:34
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Nov 10, 2020

@mattklein123 this one is ready for final review i think, and contains some important errata

not sure about windows compat issues (#13927 (comment)) but my inclination if the note there is incorrect is to remove it for now and iterate

@phlax
Copy link
Copy Markdown
Member Author

phlax commented Nov 10, 2020

@mattklein123 mattklein123 self-assigned this Nov 10, 2020
- critical
- off

You can also set the log level for specific components using the :option:`--component-log-level` option.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah I agree this would be nice. Can you open a ticket to track this?

@mattklein123
Copy link
Copy Markdown
Member

I think we can do Windows specific follow ups later.

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.

3 participants