Giter VIP home page Giter VIP logo

cli-experimental's Introduction

Build Status Go Report Card

cli-experimental

Experimental Kubectl libraries and commands.

Kustomize documentation

This repo currently hosts the code for Kustomize and Kubectl docs, which are available at https://kubectl.docs.kubernetes.io. The guide for contributing to the docs is hosted within the docs themselves.

The docs are built with Hugo and deployed with Netlify. Information about this standard setup for subproject sites can be found on the community repo.

Note that kustomize.io and kubectl.io were contributed by Replicated and are currently still sourced from their repos:

Ultimately we want to consolidate the Kustomize documentation and move the code out of the experimental repo. To learn more about that plan and get involved, see kustomize/#4338.

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

cli-experimental's People

Contributors

aibarbetta avatar annasong20 avatar barney-s avatar gaaops avatar gonmmarques avatar hosamalmoghraby avatar jongwooo avatar k8s-ci-robot avatar khanhtc1202 avatar knverey avatar koba1t avatar kodephile avatar larsks avatar leonnicolas avatar lieryan avatar liujingfang1 avatar lloydchang avatar max-wittig avatar monopole avatar natasha41575 avatar nikhita avatar pwittrock avatar rob8714 avatar rothgar avatar sachithkasthuriarachchi avatar shell32-natsu avatar syamsundarkirubakaran avatar tonglil avatar yossicohn avatar yurrriq avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cli-experimental's Issues

kustomize docs for Guides > Introduction don't show full example

I started reading about kustomize today, so I was following this page (https://kubectl.docs.kubernetes.io/guides/introduction/kustomize/). I don't see anything called quickstart on the left menu so I assumed this was the page to follow and run commands alongside to see it in action. Step 1 says "Make a kustomization file" and it shows a file structure:

~/someApp
├── deployment.yaml
├── kustomization.yaml
└── service.yaml

I grabbed the example NGINX deployment from the k8s docs and made my own deployment file. I skipped service.

Below, it says to run kustomize build ~/someApp, without providing an example kustomization.yaml file, so I assumed it would work without that file or with an empty file of that name and have some default behavior, so I ran kustomize build since I was working in the directory for my example already. No output, but no errors. I also tried kustomize build . in case I had to explicitly specify the directory to build (like the command in the docs). Same thing.

I think the docs should be improved. I can't find anywhere to actually get started. The "Examples" page doesn't seem to be somewhere I can go to get the kuztomization.yaml file I need to complete the quickstart because it's just a page displaying two links (Multibase and Inline Patch) and I don't know what those things mean yet. I don't know which one to click.

Check in vendor scss

The .gitignore file ignores the vendor directory, so some required files were not checked in.

If I try to build with hugo from the site directory I get:

Error: Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): SCSS processing failed: file "stdin", line 6, col 1: File to import not found or unreadable: ../vendor/bootstrap/scss/bootstrap

Missing content after migration

Trying to solve my problem with variables interpolation, I've accidentally noticed that changes from that PR (merged Oct 22, 2020) is not available in the version after migration.

That particular change can be manually cherry-pick here, but as the migration took place around that merge:
image

there is a chance that there is a time window when documentation changes were not propagated.

A typo in namePrefix document example?

There is a small typo in the example doc:

Example

File Input

# deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: the-deployment
spec:
  replicas: 5
  template:
    containers:
      - name: the-container
        image: registry/conatiner:latest
# kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

namePrefix: overlook-

resources:
- deployment.yaml

Build Output

apiVersion: apps/v1
kind: Deployment
metadata:
  name: alices-the-deployment
spec:
  replicas: 5
  template:
    containers:
    - image: registry/conatiner:latest
      name: the-container

Build output should have name overlook-the-deployment, not alices-the-deployment

Replace gometalinter / Fix TracisCI

Looks like all TravisCI PRs are failing: https://travis-ci.org/github/kubernetes-sigs/cli-experimental/pull_requests

build gopkg.in/alecthomas/gometalinter.v2: cannot load github.com/nicksnyder/go-i18n/i18n: cannot find module providing package github.com/nicksnyder/go-i18n/i18n

gometalinter manifest import path is now invalid with go-i18n repo having a v2 directory: https://github.com/alecthomas/gometalinter/blob/master/vendor/manifest#L21

However gometalinter was deprecated 2019-04-07, so it should probably be replaced in this project.

"Extending Kustomize" - Broken links

Howdy. Two of the four links in this section are 404'd:

https://kubectl.docs.kubernetes.io/guides/extending_kustomize/#examples

"helm chart inflator - A generator that inflates a helm chart." Link 404s.
"bashed config map - Super simple configMap generation from bash." Works.
"sed transformer - Define your unstructured edits using a plugin like this one." Works.
"hashicorp go-getter - Download kustomize layes and build it to generate resources" Link 404s.

I've personally used this link checker successfully, but it's just a suggestion. :) https://github.com/linkchecker/linkchecker Cheers!

No changelogs or anything else describing what is in kustomize releases

https://kubectl.docs.kubernetes.io/blog/

The last entry is in 2019 for kustomize version 3.3.0. But https://kubectl.docs.kubernetes.io/guides/config_management/components/ shows that there is are 3.x releases to at least 3.7, and the current release is 4.0. I haven't been able to find anything via google either.

How am I supposed to evaluate if kustomize will work for me if all the documentation is out of date or broken, and there's not even anything saying what has changed in releases? Is kustomize even something I should be looking at using?

failed to download on Mac

cannot do brew install kustomize on Mac Catalina 10.15.7 pro 16inch 2019

` brew install kustomize
Updating Homebrew...
==> Auto-updated Homebrew!
Updated 1 tap (homebrew/core).
==> New Formulae
cadence-workflow dua-cli epr minisat net-tools pcp systemd zinit
crackpkcs enkits kickstart mx organize-tool six xplr zsh-vi-mode
==> Updated Formulae
Updated 1003 formulae.
==> Renamed Formulae
fcct -> butane

==> Downloading https://homebrew.bintray.com/kustomize-4.1.1.catalina.bottle.tar.gz
#=#=#
curl: (22) The requested URL returned error: 404 Not Found
Trying a mirror...
==> Downloading https://ghcr.io/v2/homebrew/core/kustomize-4.1.1.catalina.bottle.tar.gz
==> Downloading from https://github.com/-/v2/packages/container/package/homebrew%2Fcore%2Fkustomize-4.1.1.catalina.bottle.tar.gz
#=#=#
curl: (22) The requested URL returned error: 404
Error: Failed to download resource "kustomize"
Download failed: https://ghcr.io/v2/homebrew/core/kustomize-4.1.1.catalina.bottle.tar.gz`

Binaries URL is missing

It would be helpful to provide a link to where the binaries are so that the appropriate curl command could be constructed based on seeing which ones are available and what their download path is

Give examples

The information is abstract. Please provide examples.

Installing ARM release on RPI help

Hi,
it' the first time writing something on GitHub, I'm learning. I hope is the right place.
I was trying to install kustomize on my RPI OS lite, I'm aim to install Metallb. I was thinging that maybe I could use this instructions: https://kubectl.docs.kubernetes.io/installation/kustomize/binaries/

I read the message:
This script doesn’t work for ARM architecture. If you want to install ARM binaries, please go to the release page to find the URL.

Questions:

  1. Am I followwing the right instructions? If not where I can find them?
  2. If yes where I can find the ARM URL release in the github? I searched for a while and I cannot find it.

As I said I'm begineer in this things so thank you in advance,

Exec plugin on linux

This process documented does not work. I have tried on both MacOS and Fedora.

kustomize does not accept the parameter flag as described, and does not work without it.

[mstudd@mstudd renovate]$ XDG_CONFIG_HOME=$DEMO $DEMO/bin/kustomize build --enable_alpha_plugins $MYAPP
Error: unknown flag: --enable_alpha_plugins
[mstudd@mstudd renovate]$ XDG_CONFIG_HOME=$DEMO $DEMO/bin/kustomize build $MYAPP
Error: loading generator plugins: external plugins disabled; unable to load external plugin 'SillyConfigMapGenerator'
[mstudd@mstudd renovate]$ XDG_CONFIG_HOME=$DEMO $DEMO/bin/kustomize version
{Version:kustomize/v4.0.5 GitCommit:9e8e7a7fe99ec9fbf801463e8607928322fc5245 BuildDate:2021-03-08T20:53:03Z GoOs:linux GoArch:amd64}

namePrefix

that Build Output The right answer might be metadata.name: overlook-the-deployment rather than metadata.name: alices-the-deployment

patches

The link to strategic merge page is broken. It leads to a 404 error page.

DOCS: Link to configMapGenerator from secretGenerator doc page is incorrect

On this page: https://kubectl.docs.kubernetes.io/references/kustomize/secretgenerator/

The link in "This works like the configMapGenerator." points to the secretGenerator, and not configMapGenerator.

I clicked the "Edit this page" button to submit a fix, but that lead me to a 404 page, so here I am :)

The current link: https://kubectl.docs.kubernetes.io/references/kustomize/secretgenerator/
The expected link: https://kubectl.docs.kubernetes.io/references/kustomize/configmapgenerator/

Organization

There is a lot of feature description happening in this glossary that belongs in features' subpages but isn't found there. The glossary should have a one-sentence description of the word or shouldn't exist at all. I favor the latter. The glossary should be replaced with a table of contents that lets you navigate to the page where the feature is described in detail.

Install via homebrew for macOS or Linux

Homebrew installs are supported on macOS and Linux. We should maybe separate the homebrew and macports install sections and let people running linux know that homebrew work there too.

This applies to kubectl and kustomize

Site edit button goes to the wrong location

I tried editing a page by clicking "Edit this page" from the rendered website and it brought me to

https://github.com/kubernetes-sigs/cli-experimental/edit/master/content/en/installation/krew/bash_zsh.md

But the real path is

https://github.com/kubernetes-sigs/cli-experimental/blob/master/site/content/en/installation/krew/bash_zsh.md

I didn't track down where that button is in the template so I wanted to open a quick issue to track it.

Typo/Version Documentation May Be Out of Date

I was reading through the documentation here and it says that in order to use a configMapGenerator to specify an environment from a file, you do something like:

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
configMapGenerator:
- name: tracing-options
  env: tracing.env

When I tried to do that, I got an error: Error: json: unknown field "env". After doing some googling, I found that the correct configuration was actually:

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
configMapGenerator:
- name: tracing-options
  envs:
  - tracing.env

Reference/docs make no mention of kubectl/Kustomize divergence

The reference documentation for the Kustomize tool is for Kustomize 3.0, which is not supported in any production version of kubectl to date, and neither the Kustomize reference nor the kubectl reference for kubectl kustomize make any reference to this divergence, what version was included in kubectl, or which versions several directives were added in.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.