GoogleContainerTools/skaffold

Document an example on remote modules + local module

Open

#7.392 geöffnet am 10. Mai 2022

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (1.416 Forks)batch import
bugbash/q4-2022help wantedkind/todometa/examples

Repository-Metriken

Stars
 (12.822 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 1T 18h) (18 gemergte PRs in 30 T)

Beschreibung

When talking with @russwolf, I realized we dont have an example demo for an application where there is one remote module along with local module.

e.g.

apiVersion: skaffold/v2beta11
kind: Config
requires:
- git:
    repo: https://github.com/GoogleContainerTools/skaffold
    path: examples/multi-config-microservices/leeroy-app
    ref: main

- path: ./leeroy-web

and

apiVersion: skaffold/v2beta22
kind: Config
metadata:
  name: web-config
requires:
- path: ../base
build:
  artifacts:
  - image: leeroy-web
    requires:
    - image: base
      alias: BASE
deploy:
  kubectl:
    manifests:
    - kubernetes/*
portForward:
- resourceType: deployment
  resourceName: leeroy-web
  port: 8080
  localPort: 9000

It will be cool to demo this set up to your users.

Contributor Guide

Research-Richtung
Das Issue stellt zwei YAML Konfigurationsschnipsel bereit: eine für eine skaffold Konfiguration, die ein Remote Modul (Git Repo) und ein lokales Modul erfordert, und eine andere für eine Konfiguration, die ein lokales Basis Modul verwendet. Um diese Aufgabe abzuschließen, sehen Sie sich vorhandene Beispiele im Repository im Verzeichnis 'examples/' an, z. B. 'examples/multi config microservices/leeroy app'. Erstellen Sie ein neues Beispiel oder ergänzen Sie die vorhandene Dokumentation, um zu zeigen, wie ein Skaffold Projekt mit sowohl Remote als auch lokalen Modulen eingerichtet wird. Das Beispiel sollte die bereitgestellten YAML Dateien enthalten und die Struktur erklären. Stellen Sie sicher, dass das Beispiel klar und testbar ist.
Tech Stack
go
Domain
documentationdevops
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Skaffold basicsKubernetes concepts
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85