v1 APIs and Stable Profile announcement

[whitneygriffith]

Description

This post announces the v1 API promotions and the Stable profile we have introduced as part of the Release Channels work #173

Reviewers

• Ambient
• Docs
• Installation
• Networking
• Performance and Scalability
• Extensions and Telemetry
• Security
• Test and Release
• User Experience
• Developer Infrastructure
• Localization/Translation

[istio-policy-bot]

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been a while since you've been here. A few things you should know:

• You can learn about how we write and maintain documentation, our style guidelines,
  and the available web site features by visiting Contributing to the Docs.

• In the next few minutes, an automatic preview of your change will be built with
  a full copy of the istio.io website. You can find this preview by clicking on
  the Details link next to the deploy/netlify entry in the status section of this
  page.

• We care about quality, so we've put in place a number of checks to ensure our documentation
  is top-notch. We do spell checking, sanitize the Markdown, ensure all hyperlinks point to a
  valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
  lint_istio.io entry in the status section. Click on the Details link to get a list of the
  problems with your PR. Fix those problems and push an update; this will automatically re-run the
  tests. Hopefully this time everything will be perfect!

• Once your changes are accepted and merged into the repository, they will initially show up
  on https://preliminary.istio.io. The changes will be published to https://istio.io
  the next time we do a major release (which typically happens every 3 months or so).
  To publish them sooner, add a cherrypick/release-x.xx label, where x.xx is the current
  release of Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

[craigbox]

Thanks, @whitneygriffith!

I'd love if this post could contain a bit of a preamble about the difference between API version and stability of an implementation (which I can help draft). I also think it would also be useful to talk about the work you've done with stable/experimental channels. Is that approved, or still directional? Could we hint at it in this post?

[whitneygriffith]

I'd love if this post could contain a bit of a preamble about the difference between API version and stability of an implementation (which I can help draft).

I am guessing this will go along the lines of although the APIs are v1 the associated implementation may be of a different stability level. Do you have any examples of this?

I also think it would also be useful to talk about the work you've done with stable/experimental channels. Is that approved, or still directional? Could we hint at it in this post?

The Stable Profile we mentioned under the Using the v1 Istio APIs heading is the part of the release channels that have been approved for roll out. In future iterations we will reveal more to the users as we iterate on the release channels implementation.

[mikemorris]

Minor comments on phrasing and content for target audience, overall looks solid!

[craigbox]

I am guessing this will go along the lines of although the APIs are v1 the associated implementation may be of a different stability level. Do you have any examples of this?

In general, I don't think people understand that you have an API, and one or more controllers that do something with that API. At the simplest level we may freeze the API, but we'll still be fixing bugs in the controllers.

I had a good idea in my head about how to express this but I didn't write it down at the time. i'm going to ask my brain and go do something else so I hopefully remember

[linsun]

lgtm in general.

entered two comments which i was confused when first reading it.

[craigbox]

Great post, thanks Whitney!