Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
144 lines (95 sloc) 8.05 KB

Istio Working Group Processes

This document describes the processes we use to manage the Istio working groups. This includes how they are formed, how leads are established, how they are run, etc.

Why working groups?

Istio working groups are organizations responsible for the design and implementation of large architectural aspects of the overall Istio project. Working groups operate with a fair amount of autonomy within the broader scope of the project. They tend to be long-lived, representing major initiatives over Istio’s lifetime.

Some working groups focus on specific technologies. For example, the Policy and Telemetry working group primarily focuses on Mixer. Other working groups are cross-cutting in nature such as the Performance and Scalability working group.

The Technical Oversight Committee (a.k.a. TOC) is responsible for the Istio project as a whole. It sets the overall direction of the project, helps make crosscutting architectural decisions, helps establish and dissolve working groups, and helps ensure all working groups are generally rowing in the same direction.

Although working groups are relatively lightweight structures, we want to keep the number of working groups low in order to keep things manageable.

Proposing a new working group

If you’ve identified a substantial architectural area which would benefit from long-lived, concerted and focused design, then you should consider creating a new working group. To do so, you need to:

  • Create a charter. This should be a few paragraphs explaining:

    • The mission of the working group

    • The goals of the working group (problems being solved)

    • The scope of the working group (topics, subsystems, code repos, areas of responsibility)

  • Nominate an initial set of leads. The leads set the agenda for the working group and serve as final arbiters on any technical decision. See below for information on the responsibilities of leads and requirements for nominating them.

  • Prepare a Roadmap. Create a preliminary 3 month roadmap for what the working group would focus on.

  • Send an Email. Write up an email with your charter, nominated leads, and roadmap, and post it to technical-oversight-committee. The technical oversight committee will evaluate the request and decide whether the working group should be formed, whether it should be merely a subgroup of an existing working group, or whether it should be subsumed by an existing working group.

Setting up a working group

Once approval has been granted by the technical oversight committee to form a working group, the working group leads need to take a few steps to establish the working group:

  • Create a Google Drive Folder. Create a folder to hold your working group documents within this parent folder. Call your folder "GROUP_NAME".

  • Create a Meeting Notes Document. Create a blank document in the above folder and call it "GROUP_NAME Group Meeting Notes".

  • Create a Roadmap Document. Create a document in the above folder and call it "GROUP_NAME Group Roadmap". Put your initial roadmap in the document.

  • Create a Discourse Category. Create a new category on https://discuss.istio.io and give it the name of your working group.

  • Schedule a Recurring Meeting. Create a recurring meeting (weekly or bi-weekly, 30 or 60 minutes) and call the meeting GROUP_NAME Group Sync-Up". Attach the meeting notes document to the calendar event. Generally schedule these meetings between 9:00AM to 2:59PM Pacific Time. Invite the public Google group to the meeting.

  • Register the Working Group. Go to WORKING-GROUPS.md and add your working group name, the names of the leads, the working group charter, and a link to the meeting you created.

  • Announce your Working Group. Post a note contributors to announce your new working group. Include your charter in the post.

Congratulations, you now have a fully formed working group!

Dissolving a working group

Some working groups are ephemeral or naturally reach the end of their useful life. Working group leads can petition to dissolve their working groups by posting to technical-oversight-committee. The technical oversight committee also reserves the right to dissolve or recharter working groups over time as necessary.

Leads

Each working group must have 2 or 3 leads, with at least two different organizations represented. Working group leads must be members of the Istio project (that is, have made multiple contributions to the project in the form of code, design, or documentation).

Please see the Community Roles document for a description of a lead’s role and requirements.

Running a working group

Leads are responsible for running a working group. Running the group involves a few activities:

  • Meetings. Prepare the agenda and run the regular working group meetings. Ensure the meetings are recorded, and properly archived on YouTube.

  • Notes. Ensure that meeting notes are kept up to date. Provide a link to the recorded meeting in the notes. The lead may delegate note-taking duties.

  • Roadmap. Establish and maintain a roadmap for the working group outlining the areas of focus for the working group over the next 3 months.

  • Report. Report current status to the main community meeting every 6 weeks.

Be open

The community design process is done in the open. Working groups should communicate primarily through the public working group mailing list and meetings, through design documents in the working group’s folder, through GitHub issues, and GitHub PRs. Avoid private emails and/or meeting when possible.

Making decisions

In general, working groups operate in a highly cooperative environment. Working groups discuss designs in the open and take input from the community at large when making technical choices. The working group leads are ultimately responsible for setting the direction of the working group and making the tough technical choices affecting the working group.

Subgroups

Subgroups are ad hoc subteams within a working group with a special focus on a set of problems or technologies. We don’t formalize processes for subgroups, each working group can decide when subgroups are needed and how they operate.

Escalations

Working groups can get blocked on specific technical disagreements. Leads are expected to generally resolve such issues and allow work to progress.

Sometimes, different working groups can have conflicting goals or requirements. Leads from all affected working groups generally work together and come to an agreeable conclusion.

If a community member disagrees with decisions or designs made by a working group, the first recourse is to consult the working group leads and try to hash things out. If that's not satisfactory, then the community member is invited to prepare an alternate proposal that can be shared with the community.

In all cases, remaining blocking issues can be raised to the technical oversight committee to help resolve the situation. To trigger an escalation, add an entry to the TOC's agenda and come to a Friday TOC meeting. Come prepared with an explanation of the underlying problem as well as cogent arguments for both sides.

You can’t perform that action at this time.