openfaas/docs

Document exposing the gateway on a different port

Open

#136 opened on Mar 11, 2019

View on GitHubContributor guide
 (4 comments) (1 reaction) (0 assignees)Makefile (95 forks)auto 404
good first issuehelp wanted

Repository metrics

Stars
 (67 stars)
PR merge metrics
 (PR metrics pending)

Description

Proposed change

The docs should show developers how to change the public port of the gateway. In both swarm and k8s this is not very complicated. We should warn users about exposing it publically, but for developers testing OpenFaaS they might have port conflicts on their local systems.

The docs should identify use cases and which files would need to be modified.

Context

Several users have asked about this in Slack. Documenting this will simplify the developer experience.

  • Operating System and version (e.g. Linux, Windows, MacOS):

  • Link to your project or a code example to reproduce issue:

  • Please also follow the troubleshooting guide and paste in any other diagnostic information you have:

Contributor guide

Research direction
Review the current OpenFaaS documentation for gateway deployment. Look at the Helm chart and Docker Compose files to understand port mapping. Then draft a new section explaining how to change the port for both Swarm and Kubernetes, including security warnings.
Tech stack
dockerkubernetes
Domain
cloud
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitDockerKubernetes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75