openfaas/docs

Document exposing the gateway on a different port

Aperta

#136 aperta il 11 mar 2019

Vedi su GitHubGuida contributor
 (4 commenti) (1 reazione) (0 assegnatari)Makefile (95 fork)auto 404
good first issuehelp wanted

Metriche repository

Star
 (67 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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:

Guida contributor

Direzione di ricerca
Rivedi la documentazione attuale di OpenFaaS per il deployment del gateway. Esamina i file Helm chart e Docker Compose per comprendere il mapping delle porte. Quindi redige una nuova sezione che spiega come cambiare la porta sia per Swarm che per Kubernetes, inclusi avvisi di sicurezza.
Tech stack
dockerkubernetes
Dominio
cloud
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitDockerKubernetes
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75