Skip to content

Latest commit

 

History

History
22 lines (20 loc) · 2.56 KB

GRADUATING.md

File metadata and controls

22 lines (20 loc) · 2.56 KB

Steps needed to graduate project

Those steps are generally needed to change project status (usually from Incubating to Graduated or from Sandbox to Incubating):

  • Update status in projects.yaml.
  • Add graduated_date or similar (incubating_date, archived_date).
  • Graduation/Incubation dates are here.
  • Change projects links order on all home dashboards. Take for example grafana/dashboards/all/dashboards.json, copy list of projects links into FROM file, change order accordingly and paste it into TO file.
  • Run: ./devel/dashboards_replace_from_to.sh dashboards.json.
  • Put new home dashboards: ./devel/put_all_charts.sh and then ./devel/put_all_charts_cleanup.sh. Not needed with Helm installation.
  • Update files: partials/projects.html partials/projects_health.html metrics/all/sync_vars.yaml apache/www/index_prod.html apache/www/index_test.html (remember about cncf- classes/separators). Look for /\cdevstats projects:\|projects:\|graduated:\|incubating:\|sandbox: - update counts.
  • Update projects counts (graduated, incubating, sandbox, archived) in apache/www/index_*.html, partials/projects_health.html and partials/projects.html files.
  • For updating partials/projects.html or apache/www/index_*.html, copy the Graduated/Incubating/Sandbox section into some text file and then KIND=Graduated SIZE=9 ./tsplit < graduated.txt > new_graduated.txt.
  • You only need to move projects that changed state to that text file, and then it will take care of right/left/bottom separators and dividing into columns/rows.
  • Run to update partials: PG_PASS=... ./devel/vars_all.sh. Not needed with Helm installation.
  • Update test and production www index files: apache/www/index_test.html apache/www/index_prod.html. Possibly others too like for GraphQL.
  • Update apache/*/sites-enabled/* apache/*/sites.txt files.
  • To do this you can copy prod/test section from already modified partials/projects.html and then do the following replacements:
  • :'<,'>s/\[\[hostname]]/teststats.cncf.io/g or :'<,'>s/\[\[hostname]]/devstats.cncf.io/g, followed by :'<,'>s/public\/img\/projects\///g.
  • Install them as /var/www/html/index.html on test and production respectively: cp apache/www/index_envname.html /var/www/html/index.html.
  • Install everything: make install. Not needed with Helm installation, rebuild docker images and drop static pages and grafanas pods instead.
  • See Update shared Grafana data in ADDING_NEW_PROJECT.md.