GoogleContainerTools/skaffold

Document an example on remote modules + local module

Open

#7 392 ouverte le 10 mai 2022

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Go (1 416 forks)batch import
bugbash/q4-2022help wantedkind/todometa/examples

Métriques du dépôt

Stars
 (12 822 stars)
Métriques de merge PR
 (Merge moyen 1j 18h) (18 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Le problème fournit deux extraits de configuration YAML : un pour une configuration skaffold nécessitant un module distant (dépôt Git) et un module local, et un autre pour une configuration utilisant un module de base local. Pour accomplir cette tâche, examinez les exemples existants dans le dépôt sous le répertoire 'examples/', comme 'examples/multi config microservices/leeroy app'. Créez un nouvel exemple ou ajoutez à la documentation existante pour démontrer comment configurer un projet Skaffold avec à la fois des modules distants et locaux. L'exemple doit inclure le YAML fourni et expliquer la structure. Assurez vous que l'exemple est clair et testable.
Stack technique
go
Domaine
documentationdevops
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Skaffold basicsKubernetes concepts
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85