Re: kubernetes examples/ directory

98 views
Skip to first unread message

Brian Grant

unread,
Apr 13, 2017, 12:06:10 PM4/13/17
to Ahmet Alp Balkan, kubernetes-sig-docs, kubernetes-sig-apps, hufen...@gmail.com
+SIG Docs and SIG Apps

On Wed, Apr 12, 2017 at 1:16 PM, Ahmet Alp Balkan <ahm...@google.com> wrote:
Hi Brian,

I'm in the process of figuring out the problems with the examples/ directory in the k8s main repo and kubernetes.io/docs/samples.

Great!
 
Quick braindump:

Quick braindump from me, also. :-)
 

- examples/ directory
  * has a ton of content (a lot of 3rd party examples)

Common problems with examples:
 
  * although there are officially maintained examples, many others are actively getting updated too

We can't keep examples with zero active maintainers. We should delete many of the examples.
 
  * are these important enough to be in the main repo? (adds to review overhead, PRs get merged slow)

They absolutely should not be in the kubernetes repo:

 
  * would a separate repo be better? or have 3rd party examples hosted on their separate repos?

Either the docs repo or a separate repo. 

In general, we can no longer accept content that requires specialized knowledge from people who aren't going to maintain it, however. We did that in several areas early in the project (examples, contrib, "getting-started guides", cloud providers), and they became unmaintainable burdens later. We're now at a stage in our community where not all content needs to be hosted by us. We can host high-quality, maintained, consistent content of broad interest. It's better for other content to just be posted to personal blogs, where there are fewer expectations and no maintenance burden.
 
- Some examples such as this one use GKE, and has gone out of sync with their GKE equivalent over time.

GKE examples should live only on cloud.google.com now. That example was created before there were general-purpose APIs for storage provisioning, so it wasn't possible to create examples of stateful applications that weren't dependent on some cloud provider. 
 
- Some of these solutions have Helm charts, and often they do not accomplish the same thing. But where applicable, should we deprecate some of them in favor of Helm?

Yes. Originally, some of the examples served similar roles as Helm charts, and those should be eliminated. 

The guidelines doc I linked to above attempts to explain the intended difference between examples and Helm charts.

Brian Grant

unread,
Apr 13, 2017, 12:13:32 PM4/13/17
to Ahmet Alp Balkan, kubernetes-sig-docs, kubernetes-sig-apps, zixu mo
A more general point: The examples were created prior to the existence of minikube, helm, and many other tools and features. I'd generally point to a single minikube example as part of the "prerequisites" section (i.e., you need to have a cluster, here's an easy way to get one), and whatever examples we keep need to be updated to reflect the current features and tools.

Brandon Philips

unread,
Apr 13, 2017, 12:32:29 PM4/13/17
to Brian Grant, Ahmet Alp Balkan, kubernetes-sig-docs, kubernetes-sig-apps, zixu mo
+1 to just pointing all new users to minikube. Zero cost and works quickly.

Brandon

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-apps/CAKCBhs6f7HJr9pqh6HaoQL7DpAa%2BKAe8ubtTDcEkZPeZXbpELQ%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

Brian Grant

unread,
Apr 13, 2017, 12:46:01 PM4/13/17
to Brandon Philips, Ahmet Alp Balkan, kubernetes-sig-docs, kubernetes-sig-apps, zixu mo
On Thu, Apr 13, 2017 at 9:32 AM, Brandon Philips <brandon...@coreos.com> wrote:
+1 to just pointing all new users to minikube. Zero cost and works quickly.

The main catch is that some features don't yet work in minikube.
 

Brandon

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

Sebastien Goasguen

unread,
Apr 14, 2017, 3:33:30 AM4/14/17
to Brian Grant, Brandon Philips, Ahmet Alp Balkan, kubernetes-sig-docs, kubernetes-sig-apps, zixu mo
I am game to help clean the examples directory (Ahmet let me know if you need help).

I think we should move them to `kubernetes/community/examples` or its own `kubernetes/examples`

- Agree that the GKE examples should be removed.
- Some are abandoned.
- Some are still useful (and linked from different places)

+1 on minikube of course, but note that until v0.18.0 there were big problems with Charts on minikube ( no dynamic provisioning until ~0.15, and permissions issues on hotPath volumes that broke pvc ).

So we will also need a way to continuously test examples on minikube to properly maintain them.

-Sebastien

 

Brandon

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsubscribe...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-apps/CAKCBhs6yXuMaRZDVgu7gvBhMX3%3DmDYLA66E24_HP4uZS-mEbsQ%40mail.gmail.com.

Brian Grant

unread,
Apr 14, 2017, 3:38:02 AM4/14/17
to Sebastien Goasguen, Brandon Philips, Ahmet Alp Balkan, kubernetes-sig-docs, kubernetes-sig-apps, zixu mo
On Fri, Apr 14, 2017 at 12:33 AM, Sebastien Goasguen <run...@gmail.com> wrote:
I am game to help clean the examples directory (Ahmet let me know if you need help).

Thanks! 

I think we should move them to `kubernetes/community/examples` or its own `kubernetes/examples`

Not the community repo, please.
 

- Agree that the GKE examples should be removed.
- Some are abandoned.
- Some are still useful (and linked from different places)

+1 on minikube of course, but note that until v0.18.0 there were big problems with Charts on minikube ( no dynamic provisioning until ~0.15, and permissions issues on hotPath volumes that broke pvc ).

So we will also need a way to continuously test examples on minikube to properly maintain them.

-Sebastien

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

Ihor Dvoretskyi

unread,
Apr 14, 2017, 4:44:18 AM4/14/17
to Brian Grant, Sebastien Goasguen, Brandon Philips, Ahmet Alp Balkan, kubernetes-sig-docs, kubernetes-sig-apps, zixu mo
> Not the community repo, please.

Why?


--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-docs@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-docs/CAKCBhs7ajOaJcPF-yUWRur3%2BEmyNnH29jAVgn0PjevfqC8GCpQ%40mail.gmail.com.

Brian Grant

unread,
Apr 14, 2017, 10:16:52 AM4/14/17
to Ihor Dvoretskyi, Sebastien Goasguen, Brandon Philips, Ahmet Alp Balkan, kubernetes-sig-docs, kubernetes-sig-apps, zixu mo
On Fri, Apr 14, 2017 at 1:44 AM, Ihor Dvoretskyi <ihor.dv...@gmail.com> wrote:
> Not the community repo, please.

Why?

First, the audiences are different. community is for contributors. examples are for users.

Second, we need to move towards single-purpose repos. Grab-bag repos like kubernetes and contrib are problematic to maintain, evolve, and consume.
 

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsubscribe...@googlegroups.com.

Ihor Dvoretskyi

unread,
Apr 14, 2017, 10:28:57 AM4/14/17
to Brian Grant, Sebastien Goasguen, Brandon Philips, Ahmet Alp Balkan, kubernetes-sig-docs, kubernetes-sig-apps, zixu mo
Understood.

So, I would vote for kubernetes/examples dedicated repo - as a granular item (it can be easily cloned and used separately without the necessity to clone the whole kubernetes/kubernetes repo).

Michail Kargakis

unread,
Apr 17, 2017, 10:45:50 AM4/17/17
to Ihor Dvoretskyi, Brian Grant, Sebastien Goasguen, Brandon Philips, Ahmet Alp Balkan, kubernetes-sig-docs, kubernetes-sig-apps, zixu mo
+1 for kubernetes/examples

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.

To post to this group, send email to kubernetes-sig-apps@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-apps/CA%2BhxP0t1t9XVpVVQRS4Xo7--O6ekBT%3DZkbte%2BMcG5HeASactWA%40mail.gmail.com.

Ahmet Alp Balkan

unread,
Apr 18, 2017, 5:31:03 PM4/18/17
to Michail Kargakis, Ihor Dvoretskyi, Brian Grant, Sebastien Goasguen, Brandon Philips, kubernetes-sig-docs, kubernetes-sig-apps, zixu mo
Sorry for starting the discussion and then totally forgetting about it. :) It looks like Brian has just created https://github.com/kubernetes/examples (thanks!). I'll draft a migration plan and the way forward soon. I will present it to the SIG Apps and SIG Docs (any other relevant SIGs?). I could really use help bringing the examples up to date (also cleaning up, identifying what shouldn’t be kept anymore) and any other help throughout this transition. But let me hash out the rough details first and prepare a proposal for sig-apps.

+1 for kubernetes/examples

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsubscribe...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

Ahmet Alp Balkan

unread,
May 1, 2017, 11:48:52 AM5/1/17
to Michail Kargakis, Ihor Dvoretskyi, Brian Grant, Sebastien Goasguen, Brandon Philips, kubernetes-sig-docs, kubernetes-sig-apps, zixu mo
I started a proposal draft to move the examples/ out to their own repository. Please read and leave comments: https://docs.google.com/document/d/15eRNrOtofhl1tFyXgZYw3pV4Z9S4PF1TU1iejGnv1f4/edit?usp=sharing 

Highlights:
1. We have a set of maintained examples showcasing some features, let's keep those.
2. Lots of 3rd party vendor/ecosystem software examples made their way to this directory once, let’s contact their maintainers (if active) and get these deleted.
3. Some of the examples could live in the docs repo as their point is to demonstrate usage of a particular feature.

I can talk about it in the SIG meeting (in 10 minutes) if there is any interest.

Michelle Noorali

unread,
May 1, 2017, 11:55:57 AM5/1/17
to Ahmet Alp Balkan, Michail Kargakis, Ihor Dvoretskyi, Brian Grant, Sebastien Goasguen, Brandon Philips, kubernetes-sig-docs, kubernetes-sig-apps, zixu mo
That sounds good Ahmet. You're welcome to talk about it today. Thanks.

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.

To post to this group, send email to kubernetes-sig-apps@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-apps/CAEBbUmZj4RO6jW0Te87w%2BQoKJL9PGuDq_bM25EAXNjDzRQTKjg%40mail.gmail.com.

Sebastien Goasguen

unread,
May 1, 2017, 12:18:29 PM5/1/17
to Michelle Noorali, Ahmet Alp Balkan, kubernetes-sig-docs, kubernetes-sig-apps
Ahmet, fwiw I sent a PR to try to move the examples:


it is a first step, once merged, we can clean up the original repo.




On Mon, May 1, 2017 at 5:55 PM, Michelle Noorali <mich...@deis.com> wrote:
That sounds good Ahmet. You're welcome to talk about it today. Thanks.

Ahmet Alp Balkan

unread,
May 1, 2017, 1:17:37 PM5/1/17
to Sebastien Goasguen, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
I'm not sure if moving all over initially is a great plan. We'll have a followup meeting to discuss topics like what's the final home for the examples that are not actively maintained. So instead of redirecting users to the new repo and then to their final destination, we can start from scratch by just importing what we will actually need in the main repo.

Can we hold off on this until we have a clear path forward Sebastien?

Sebastien Goasguen

unread,
May 1, 2017, 2:53:19 PM5/1/17
to Ahmet Alp Balkan, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
I think they are two things with these apps examples:

- some of them are outdated or abandoned (which you clearly point out in your doc)
- they need to be moved outside of the main repo (except the ones that are part of the release) to gain momemtum, this is part of the repo breakup effort that has been ongoing for a while.

So if we take a clue from the move of the /docs/devel to the /community repo, we can just:

1- move them (note we can move without deleting them at first)
2- clean them up (i.e remove the abandoned ones)

I am of the thought to JFDI. Especially that all examples (bad or not) will need a relocation link for couple releases.
We will have higher momentum to correct all the examples or remove them if we work in kubernetes/examples .

That said I will comment on your doc,

And if there is a better location for this discussion let me know.

BTW (Brian made me maintainer of the kubernetes/examples repo, I can add anybody who is in an org member or add a collborator I suppose, just ping me).

-seb

Ahmet Alp Balkan

unread,
May 1, 2017, 4:15:12 PM5/1/17
to Sebastien Goasguen, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
One of the consensuses from the meeting was that deleting good but abandoned content might be harmful, as some people might still be using those. (At this point, we don't have a clear list of ownership, so we don't know what is abandoned.) I am hoping we can reach out to owners of each sample to have them move those to their companies’ repos (or to a new org we create).

The problem with your PR (taking all and just moving them over) doesn't solve the following problems stated:
- it will still be unorganized
- it will not be clear which examples are tutorial material and which ones are recipes to "run X on Kubernetes"
- it will not be clear which ones are officially maintained and which ones are not

That's why my proposal is about keeping the kubernetes/examples repo purely to 4-5 official samples we maintain. These will all follow (1) a predefined tutorial template/language to be consistent with the other tutorials (2) will be education material and will be shown on the Kubernetes website (3) will be updated/tested on each release to make sure they keep working fine.

We can increase the number tutorials and the coverage of topics but just moving everything over doesn’t solve the main problems. That’s why I think we should discuss about this more (I was surprised how many people were interested in today’s SIG meeting), we will have a follow-up meeting. If you want to move only the maintained samples (I think we have only 3-4 at this point) to the new repository, I am okay with JFDI.

(P.S. feel free to add me on the repo as collaborator: ahmetb)

+1 for kubernetes/examples

 

Brandon

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-docs/CACZ5N2ZzKzM4RzZvTCRtkcZorQdgv3WB9HG24cN9%3D2KRh51qXg%40mail.gmail.com.

Ihor Dvoretskyi

unread,
May 2, 2017, 5:44:02 AM5/2/17
to Ahmet Alp Balkan, Sebastien Goasguen, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
This topic is good for consideration in scope of Kubernetes conformance. +William Denniss who is driving the Kubernetes conformance initiative on CNCF-level.

To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-apps/CAEBbUmbakKJofTkNAQuygSB0k3cqVBSQCs5%2BBKOpyoAyEp5g-w%40mail.gmail.com.

Brian Grant

unread,
May 2, 2017, 12:32:30 PM5/2/17
to Ihor Dvoretskyi, Ahmet Alp Balkan, Sebastien Goasguen, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
On Tue, May 2, 2017 at 2:43 AM, Ihor Dvoretskyi <ihor.dv...@gmail.com> wrote:
This topic is good for consideration in scope of Kubernetes conformance. +William Denniss who is driving the Kubernetes conformance initiative on CNCF-level.

Which topic?
 

+1 for kubernetes/examples

 

Brandon

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-docs@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-docs@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-apps/CA%2BhxP0sEH6BETMyyZkVB%3DQrdrBs7PgqLVOk4bjAs72BBca_R4w%40mail.gmail.com.

Ihor Dvoretskyi

unread,
May 2, 2017, 12:34:48 PM5/2/17
to Brian Grant, Ahmet Alp Balkan, Sebastien Goasguen, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps

In this case - unifying the examples.


+1 for kubernetes/examples

 

Brandon

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

Brian Grant

unread,
May 2, 2017, 12:39:13 PM5/2/17
to Ihor Dvoretskyi, Ahmet Alp Balkan, Sebastien Goasguen, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
All Helm charts, other example applications, documentation, apiserver configuration, etc. will need to be aligned around a common set of profiles, but I do not see an especially strong connection between these examples and the conformance effort, and would prefer not to tie them together. The primary problems we're trying to address regarding example quality, consistency, pedagogical value, maintenance, etc. don't relate to conformance.

+1 for kubernetes/examples

 

Brandon

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-docs@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-docs@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

Ahmet Alp Balkan

unread,
May 2, 2017, 12:46:03 PM5/2/17
to Brian Grant, Ihor Dvoretskyi, Sebastien Goasguen, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
Who can help us get a follow up meeting with sig-apps? 

It looks like we do not have consensus on the proposal. We should discuss it further.

My proposal in a nutshell:
1) move only the maintained 3-4 examples over to the new kubernetes/examples repo
2) make sure these examples follow the guidelines and have them shown as Tutorials on the k8s.io website (today they're just links to github)
3) get rid of rest of the {third party software, unmaintained} examples gracefully (etune suggested we can offer repos for these in a new gh org)

Sebastien brought up opinions in a different direction about what we should have in the new repository (see the doc). There were many people interested in the topic in yesterday’s meeting which is delighting to see. I hope we can discuss further.

I’ll also present the proposal in SIG Docs meeting today 10:30am PST and see what they think about it.

Brian and others: If you have opinions about what we should do with the new repo have and with the existing examples, please chime in.

+1 for kubernetes/examples

 

Brandon

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsubscribe...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsubscribe...@googlegroups.com.

To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsubscribe...@googlegroups.com.

To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsubscribe...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsubscribe...@googlegroups.com.

To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsubscribe...@googlegroups.com.

To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsubscribe...@googlegroups.com.

To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsubscribe...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsubscribe...@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsubscribe...@googlegroups.com.

To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-apps@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-apps/CAKCBhs5z7FOEh%3Dtnmty4dVJrT2598y-qUeMdQitCPqNw8UrnFQ%40mail.gmail.com.

Brian Grant

unread,
May 2, 2017, 4:42:33 PM5/2/17
to Ahmet Alp Balkan, Ihor Dvoretskyi, Sebastien Goasguen, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
On Tue, May 2, 2017 at 9:45 AM, 'Ahmet Alp Balkan' via kubernetes-sig-docs <kubernete...@googlegroups.com> wrote:
Who can help us get a follow up meeting with sig-apps? 

It looks like we do not have consensus on the proposal. We should discuss it further.

My proposal in a nutshell:
1) move only the maintained 3-4 examples over to the new kubernetes/examples repo
2) make sure these examples follow the guidelines and have them shown as Tutorials on the k8s.io website (today they're just links to github)
3) get rid of rest of the {third party software, unmaintained} examples gracefully (etune suggested we can offer repos for these in a new gh org)

Sebastien brought up opinions in a different direction about what we should have in the new repository (see the doc). There were many people interested in the topic in yesterday’s meeting which is delighting to see. I hope we can discuss further.

I’ll also present the proposal in SIG Docs meeting today 10:30am PST and see what they think about it.

Brian and others: If you have opinions about what we should do with the new repo have and with the existing examples, please chime in.

My braindump earlier in the thread captured most of my opinion. I care more about the end result than how we get there.

However, a quick glance also reminds me that some "examples" should be tasks in kubernetes.github.io, and others (https://github.com/kubernetes/kubernetes/tree/master/examples/volumes) perhaps should be hosted in their own github org (kubernetes-volume-providers?).

Also, FWIW, we should have analytics data to provide information about which examples are looked at with any frequency.
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/examples/runtime-constraints/README.md?pixel)]()
 

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsub...@googlegroups.com.

To post to this group, send email to kubernetes-sig-docs@googlegroups.com.

Ahmet Alp Balkan

unread,
May 2, 2017, 4:53:27 PM5/2/17
to Brian Grant, Ihor Dvoretskyi, Sebastien Goasguen, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
"Tasks" are more feature-specific and brief. (e.g. configuring env. vars on pods, installing kubectl etc). These long/scenario-oriented tutorials won’t fit there.

We're in progress of merging "Tutorials" and "Samples" into just Tutorials. The tutorials reflect a real-world scenario and walk you through from beginning to the end.

Maintained examples in question will land into the Tutorials section. Today, none of these tutorials are rendered on the website. They are just links to GitHub.

Some of these tutorials (e.g. guestbook) are actually used in e2e tests apparently. Sebastian suggested that's why they should stay in the main repo. (Opinions?)

Volume examples only serve documentation purposes. That’s why we can move them to the docs repository. That said, a new kubernetes-volume-providers org/repo is not a bad idea either.

I’m just against moving everything over to kubernetes/examples. Maybe we should just call the new repo kubernetes/tutorials. Sebastien, wdyt?

On Tue, May 2, 2017 at 1:42 PM, 'Brian Grant' via kubernetes-sig-apps <kubernete...@googlegroups.com> wrote:


--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-apps" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.

To post to this group, send email to kubernetes-sig-apps@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-apps/CAKCBhs5u6RkbC4yUKzS-P8aHfTBvdwQvBdJ4TFbBk01NdZ0htA%40mail.gmail.com.

Brian Grant

unread,
May 2, 2017, 6:54:30 PM5/2/17
to Ahmet Alp Balkan, Ihor Dvoretskyi, Sebastien Goasguen, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
On Tue, May 2, 2017 at 1:53 PM, Ahmet Alp Balkan <ahm...@google.com> wrote:
"Tasks" are more feature-specific and brief. (e.g. configuring env. vars on pods, installing kubectl etc). These long/scenario-oriented tutorials won’t fit there.


We're in progress of merging "Tutorials" and "Samples" into just Tutorials. The tutorials reflect a real-world scenario and walk you through from beginning to the end.

Maintained examples in question will land into the Tutorials section. Today, none of these tutorials are rendered on the website. They are just links to GitHub.

Some of these tutorials (e.g. guestbook) are actually used in e2e tests apparently. Sebastian suggested that's why they should stay in the main repo. (Opinions?)

Volume examples only serve documentation purposes. That’s why we can move them to the docs repository. That said, a new kubernetes-volume-providers org/repo is not a bad idea either.

I’m just against moving everything over to kubernetes/examples. Maybe we should just call the new repo kubernetes/tutorials. Sebastien, wdyt?

Ahmet Alp Balkan

unread,
May 10, 2017, 4:09:03 PM5/10/17
to Brian Grant, Ihor Dvoretskyi, Sebastien Goasguen, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
If folks are still interested in this, we can have a follow up meeting.

But just to move this forward, I might be okay with Sebastien's PR just copying everything over to the new kubernetes/examples repo.

Sebastien, can you please explain how you're planning to delete pretty much everything but the 4-5 maintained examples with this plan? I'm not clear how it helps with most of the problems listed in the proposal other than moving the same problems to a brand new repo.

Perhaps I'm getting your intention wrong (or conveying my proposal wrong):

- We need 4-5 tutorials located in examples/ directory to be maintained outside the main repo (maybe we need a separate kubernetes/tutorials repo for this).
- We need to get rid of the examples/ directory in the main repo (I don't see how moving them to this new repo solves the problem, as it’s just moving bunch of unmaintained/unorganized content from one place to another, won't this be another kubernetes/contrib?).

We need a resolution here, what should we do?

Sebastien Goasguen

unread,
May 11, 2017, 3:12:09 AM5/11/17
to Ahmet Alp Balkan, Brian Grant, Ihor Dvoretskyi, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps

Sebastien, can you please explain how you're planning to delete pretty much everything but the 4-5 maintained examples with this plan? I'm not clear how it helps with most of the problems listed in the proposal other than moving the same problems to a brand new repo.

Perhaps I'm getting your intention wrong (or conveying my proposal wrong):


Hi Ahmet and all,

I am not trying to clean the examples just yet. It needs to be done, but I believe the most pressing is to move the examples out of the main repo (they are part of the release, so we are currently shipping broken examples) 

So the intention is to get them out of kuberenetes/kubernetes , just like we got the docs out to kubernetes/community/contributors/devel

Once they are out we will be able to have much higher velocity in PR merge to fix them or delete them.

it does not solve the problems you highlight in the docs, this would be left for after the move.
 
- We need 4-5 tutorials located in examples/ directory to be maintained outside the main repo (maybe we need a separate kubernetes/tutorials repo for this).
- We need to get rid of the examples/ directory in the main repo (I don't see how moving them to this new repo solves the problem, as it’s just moving bunch of unmaintained/unorganized content from one place to another, won't this be another kubernetes/contrib?).

We can't just delete them flat out, because they are linked from unknown places (e.g docs repo, contributors/devel pages ?) and some users unknown to us may be going to those pages for specific tips ( I was not able to check the stats from Google analytics).

So my proposal would be to move them (keeping a transfer link in the main repo for several releases), then we have time to implement your proposal and potential variations of it in the new repo. 

Brian Grant

unread,
May 11, 2017, 11:42:29 AM5/11/17
to Sebastien Goasguen, Ahmet Alp Balkan, Ihor Dvoretskyi, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
On Thu, May 11, 2017 at 12:12 AM, Sebastien Goasguen <run...@gmail.com> wrote:


Sebastien, can you please explain how you're planning to delete pretty much everything but the 4-5 maintained examples with this plan? I'm not clear how it helps with most of the problems listed in the proposal other than moving the same problems to a brand new repo.

Perhaps I'm getting your intention wrong (or conveying my proposal wrong):


Hi Ahmet and all,

I believe we're only debating the process and not the goal?
 

I am not trying to clean the examples just yet. It needs to be done, but I believe the most pressing is to move the examples out of the main repo (they are part of the release, so we are currently shipping broken examples) 

So the intention is to get them out of kuberenetes/kubernetes , just like we got the docs out to kubernetes/community/contributors/devel

Yes, this is the approach we took with contrib, kubernetes.github.io, and the contributor docs. Please do the move such that it preserves git history.
 

Once they are out we will be able to have much higher velocity in PR merge to fix them or delete them.

it does not solve the problems you highlight in the docs, this would be left for after the move.
 
- We need 4-5 tutorials located in examples/ directory to be maintained outside the main repo (maybe we need a separate kubernetes/tutorials repo for this).

As much as I'm a fan of small, focused repos, I don't think we need yet another repo for this.

Helm charts are divided into stable and incubating:

We could similarly subdivide the examples, initially with all in incubating.
 
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-apps+unsub...@googlegroups.com.

To post to this group, send email to kubernetes-sig-apps@googlegroups.com.

Brian Grant

unread,
May 11, 2017, 11:56:48 AM5/11/17
to Sebastien Goasguen, Ahmet Alp Balkan, Ihor Dvoretskyi, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
On Thu, May 11, 2017 at 8:42 AM, Brian Grant <brian...@google.com> wrote:
On Thu, May 11, 2017 at 12:12 AM, Sebastien Goasguen <run...@gmail.com> wrote:


Sebastien, can you please explain how you're planning to delete pretty much everything but the 4-5 maintained examples with this plan? I'm not clear how it helps with most of the problems listed in the proposal other than moving the same problems to a brand new repo.

Perhaps I'm getting your intention wrong (or conveying my proposal wrong):


Hi Ahmet and all,

I believe we're only debating the process and not the goal?

Ok, there are 2 goals:

1. Moving the content:

2. Creating a more manageable set of well maintained examples.
...

I agree on doing #1 ASAP, and then iterating on #2.


 

Michelle Noorali

unread,
May 11, 2017, 2:57:31 PM5/11/17
to Brian Grant, Sebastien Goasguen, Ahmet Alp Balkan, Ihor Dvoretskyi, wden...@google.com, kubernetes-sig-docs, kubernetes-sig-apps
Ahmet - you are welcome to do a standup/status update at the next SIG Apps meeting if you'd like a short conversation with the group about progress. Totally optional. Hope that helps.

Ahmet Alp Balkan

unread,
May 11, 2017, 3:06:52 PM5/11/17
to Brian Grant, Sebastien Goasguen, Ihor Dvoretskyi, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
Sounds good. Let's move forward with Sebastien's PR. Sebastien, do you mind adding me as contributor as well?

I will update the proposal to reflect the change in priorities and the execution plan.

Sebastien Goasguen

unread,
May 19, 2017, 5:32:30 PM5/19/17
to Ahmet Alp Balkan, Brian Grant, Ihor Dvoretskyi, wden...@google.com, Michelle Noorali, kubernetes-sig-docs, kubernetes-sig-apps
Sorry for the delay,

I re-sent a PR for this, sticking all examples in a /staging directory:


I don't think the repo is setup yet with proper @mention capabilities, but I feel it is a big PR that people need to be aware off.
The redirects are not done in the main repo, but it is a good idea to do it asap, to avoid divergence.

I commented on: https://github.com/kubernetes/kubernetes/issues/24343 to leave a trace and ping @kubernetes/examples original maintainers/contributors.

-Sebastien

Reply all
Reply to author
Forward
0 new messages