Skip to content

OWLS-91862 - Documentation for console and WLST access using kubectl port-forward and code changes to handle multiple custom admin channels. #2520

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

Merged
merged 19 commits into from
Sep 9, 2021

Conversation

ankedia
Copy link
Member

@ankedia ankedia commented Aug 31, 2021

The documentation for console and WLST access using kubectl port-forward and changes to handle multiple custom admin channel use-case. Added unit tests for the admin port enabled and multiple custom admin channel use-case.

@tbarnes-us
Copy link

tbarnes-us commented Aug 31, 2021

General comments:

  • The "access a domain" remote console chapter should be updated to mention the port-forward option.
  • The "access a domain" WLST chapter is in general need of update.
  • I have a few edits in mind for the new chapter, but don't have time right now. May I have the 'token' so that I can make them directly by say, Thursday EOD?

[ANIL]

  • I'm not familiar with the remote console, will go through that chapter to see where port-forward option can be mentioned.
  • Ok.
  • Sure, go ahead. In case I need to make any changes based on other review comments or if I remember something, I will keep them local for now and merge them with your changes after you're done editing. Thanks.

```
Forwarding from 127.0.0.1:32015 -> 7001
```

Copy link
Member

Choose a reason for hiding this comment

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

Should there be a cleanup notes for ending the forwarding session?

Copy link
Member Author

Choose a reason for hiding this comment

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

Added a Terminating the port-forward session section in 0d1a9a1 .

@ankedia ankedia marked this pull request as ready for review September 2, 2021 17:17
@ankedia ankedia changed the title OWLS-91862 - Draft documentation for console and WLST access using kubectl port-forward. OWLS-91862 - Documentation for console and WLST access using kubectl port-forward. Sep 2, 2021
@tbarnes-us
Copy link

@jshum2479 and @rjeberhard, I've pushed a number of doc updates on top of Anil's updates.

If you two are fine with the doc, then it is ready for @rosemarymarano to make a pass.

Ryan, I'd especially like you to review all of my version number references (search for 4.0 and 3.3).


#### WebLogic HTTP channels

When providing remote access to HTTP using a load balancer or similar,
Copy link
Member

Choose a reason for hiding this comment

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

"or similar" is confusing here. I know that we mean something like an Ingress gateway, but it's not obvious here. It might be worth spelling it out a bit more such as "load balancer, Ingress gateway, or similar technology,"

Choose a reason for hiding this comment

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

Done.

is preferred over a default port because a default port supports
multiple protocols.

Do not enable tunneling on an HTTP channel unless you specifically
Copy link
Member

Choose a reason for hiding this comment

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

One of the new security validations complains if tunneling is simply enabled. Given that, we probably should more clearly recommend against using tunneling unless the port is more protected on the network.

Choose a reason for hiding this comment

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

Done.


### Overview

Beginning with WebLogic Kubernetes Operator version 3.3.2,
Copy link
Member

Choose a reason for hiding this comment

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

This looks fine to me, but we should ask Rosemary to help us wordsmith this. There probably is some simpler way to express this. :)

Choose a reason for hiding this comment

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

@rosemarymarano Once the ball is in your court, please see ^^^.

Copy link
Member

Choose a reason for hiding this comment

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

@tbarnes-us @rjeberhard Sure. "...help us wordsmith this. There probably is some simpler way to express this.
One question: to what are you referring as "this," the Overview section or something else?

Copy link
Member

Choose a reason for hiding this comment

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

I thought that the wording was fine.

@ankedia
Copy link
Member Author

ankedia commented Sep 8, 2021

@rjeberhard, @jshum2479, and @lennyphan - Can you please re-review my changes to handle multiple custom admin channels in 82672c1 ? Thanks in advance.

Copy link
Member

@lennyphan lennyphan left a comment

Choose a reason for hiding this comment

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

LGTM. Any unit tests for adding multiple internal admin channels?

[ANIL] I have added unit tests for multiple internal admin channels and when admin port is enabled in 0b9d8b8 . Please let me know if I missed something.

@ankedia ankedia changed the title OWLS-91862 - Documentation for console and WLST access using kubectl port-forward. OWLS-91862 - Documentation for console and WLST access using kubectl port-forward and code changes to handle multiple custom admin channels. Sep 9, 2021
@rjeberhard rjeberhard merged commit 368784f into main Sep 9, 2021
@ankedia ankedia deleted the owls_91862 branch September 10, 2021 13:17
ankedia added a commit that referenced this pull request Sep 13, 2021
…port-forward and code changes to handle multiple custom admin channels. (#2520)

* Support kubectl port-forward pattern

Co-authored-by: Tom Barnes <tom.barnes@oracle.com>
Co-authored-by: Rosemary Marano <rosemary.marano@oracle.com>
rjeberhard pushed a commit that referenced this pull request Sep 13, 2021
…nChannelPortForwardingEnabled to false. (#2532)

* Owls 91273 - Create network access points for kubectl port-forward and console access (#2507)

* Create network access points for kubectl port-forward and console access

* OWLS-91862 - Documentation for console and WLST access using kubectl port-forward and code changes to handle multiple custom admin channels. (#2520)

* Support kubectl port-forward pattern

Co-authored-by: Tom Barnes <tom.barnes@oracle.com>
Co-authored-by: Rosemary Marano <rosemary.marano@oracle.com>

* Change adminChannelPortForwardingEnabled default to false.

* Change the default ADMIN_CHANNEL_PORT_FORWARDING_ENABLED env variable value to false.

* Enabled port forwarding for unit tests.

Co-authored-by: Tom Barnes <tom.barnes@oracle.com>
Co-authored-by: Rosemary Marano <rosemary.marano@oracle.com>
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.

6 participants