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

Update documentation for Proxy IP addresses and ports #2179

Merged
merged 5 commits into from
Dec 11, 2019
Merged

Conversation

asaj
Copy link
Contributor

@asaj asaj commented Dec 11, 2019

Description

This PR explains which ports need to be open on which IPs, and adds commands to check that the machine is accepting TCP connections over those ports.

Does not check UDP.

Tested

Not tested

Other changes

None

Related issues

@asaj
Copy link
Contributor Author

asaj commented Dec 11, 2019

@nambrot please let me know what I'm missing for the attestations service

@codecov
Copy link

codecov bot commented Dec 11, 2019

Codecov Report

Merging #2179 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2179   +/-   ##
=======================================
  Coverage   74.77%   74.77%           
=======================================
  Files         280      280           
  Lines        7826     7826           
  Branches      974      974           
=======================================
  Hits         5852     5852           
  Misses       1858     1858           
  Partials      116      116
Flag Coverage Δ
#mobile 74.77% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2cbf04b...a21ecea. Read the comment docs.

@nambrot
Copy link
Contributor

nambrot commented Dec 11, 2019

For the attestation machine, it would be port 30303 as well on udp/tcp for discovery of the node, and then port 80 for the service itself

@nambrot nambrot assigned asaj and unassigned nambrot Dec 11, 2019
| CELO_VALIDATOR_SIGNER_BLS_SIGNATURE | A proof-of-possession of the BLS public key | |
| PROXY_ENODE | The enode address for the Validator proxy | |
| PROXY_INTERNAL_IP | (Optional) The internal IP address over which your Validator can communicate with your Proxy | |
| PROXY_EXTERNAL_IP | The external IP address of the Proxy. May be used by the Validator to communicate with the Proxy if PROXY_INTERNAL_IP is unspecified | |
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can add that people can test their external IP address by running the following command:

dig +short myip.opendns.com @resolver1.opendns.com

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are instructions below to use telnet, is dig preferable?

Copy link
Member

Choose a reason for hiding this comment

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

Telnet is good at checking whether your port is open, but this command tells you what your external IP is.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah gotcha, perfect, thanks.


```bash
# On the validator machine
export PROXY_ENODE=<YOUR-PROXY-ENODE>
export PROXY_IP=<PROXY-MACHINE-EXTERNAL-IP-ADDRESS>
export PROXY_EXTERNAL_IP=<PROXY-MACHINE-EXTERNAL-IP-ADDRESS>
export PROXY_INTERNAL_IP=<PROXY-MACHINE-INTERNAL-IP-ADDRESS>
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can list that dig command here instead.

Copy link
Member

@marekolszewski marekolszewski left a comment

Choose a reason for hiding this comment

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

Looks good! Again I would add that dig command before merging.

@asaj asaj merged commit 4714d0e into master Dec 11, 2019
@asaj asaj deleted the asaj/ip-docs branch December 11, 2019 07:38
aaronmgdr added a commit that referenced this pull request Dec 12, 2019
* master: (41 commits)
  Add /test_attestations endpoint on the attestation service (#2189)
  Overhaul readme (#2201)
  Dont show this error for now (#2205)
  Changing validator group voting gold (#2171)
  Add attestation info for reconnecting (#2195)
  Add reconnecting to a network to docs (#2190)
  Add instructions for transitioning from phase 1.0 to phase 1.1 (#2177)
  VM monitoring, bigger VMs, persistent disks for full nodes, prom to sd for proxies (#2176)
  Three little improvements to website (#2161)
  Fix/contractkit test flakyness (#2150)
  [Wallet] Fix bug causing banner to stay visible once app is connected (#2154)
  Update documentation for Proxy IP addresses and ports (#2179)
  Add Baklava phase 1.1 accounts to genesis block (#2173)
  Use fluentd natively for structured logging (#2174)
  Swallowing error for more friendly cli UX (#2175)
  Allow the validator account to whitelist hotfixes (#2166)
  Clarify requirements for local vs remote machines (#2172)
  Calculate epoch rewards adjusted for validator group uptime (#2104)
  Remove ref to script, dont expose port on ext interface in docker cmd lines, add back security reminder about this. Remove ref to office hours (#2170)
  Slashing: Adding forceDeaffiliateIfValidator fn to Validators.sol (#2095)
  ...

# Conflicts:
#	packages/web/src/about/Team.tsx
#	packages/web/src/about/VideoCover.tsx
#	packages/web/src/utils/utils.ts
aaronmgdr added a commit that referenced this pull request Dec 12, 2019
* master: (377 commits)
  Add /test_attestations endpoint on the attestation service (#2189)
  Overhaul readme (#2201)
  Dont show this error for now (#2205)
  Changing validator group voting gold (#2171)
  Add attestation info for reconnecting (#2195)
  Add reconnecting to a network to docs (#2190)
  Add instructions for transitioning from phase 1.0 to phase 1.1 (#2177)
  VM monitoring, bigger VMs, persistent disks for full nodes, prom to sd for proxies (#2176)
  Three little improvements to website (#2161)
  Fix/contractkit test flakyness (#2150)
  [Wallet] Fix bug causing banner to stay visible once app is connected (#2154)
  Update documentation for Proxy IP addresses and ports (#2179)
  Add Baklava phase 1.1 accounts to genesis block (#2173)
  Use fluentd natively for structured logging (#2174)
  Swallowing error for more friendly cli UX (#2175)
  Allow the validator account to whitelist hotfixes (#2166)
  Clarify requirements for local vs remote machines (#2172)
  Calculate epoch rewards adjusted for validator group uptime (#2104)
  Remove ref to script, dont expose port on ext interface in docker cmd lines, add back security reminder about this. Remove ref to office hours (#2170)
  Slashing: Adding forceDeaffiliateIfValidator fn to Validators.sol (#2095)
  ...

# Conflicts:
#	packages/web/src/community/connect/ConnectPage.tsx
#	packages/web/src/community/connect/Fellow.tsx
#	packages/web/src/dev/CoverAction.tsx
#	packages/web/src/ecosystem/EcoFund.tsx
#	packages/web/src/shared/Button.3.tsx
#	packages/web/src/shared/ConnectionFooter.tsx
#	packages/web/src/shared/SocialChannels.tsx
#	packages/web/src/shared/menu-items.ts
#	packages/web/static/locales/en/community.json
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.

5 participants