prometheus / prometheus/circleci

Should there be more documentation for 3rd party's who intend to use this?

Open
#22 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
9
Forks
17
PR merge metrics
No merged PRs in 30d

Description

I'm maintainer for 2 exporters for Apache and PHP-FPM

Ideally I would be consistent with the official exporters and implement the same CI/CD and release process.

Would be nice if you would document the details that non officials exporters would need to implement this.

So far, it seems I'd need to override the default organization parameters from the orb so that the final .cirlceci.yml would look like. Since I'm not active user of Circle CI having all this documented in advnace would make my life much easier.

It would probably be good to document all the env variables needed to make this work.

(Docker/Quay users, etc)

      - prometheus/publish_master:
          context: org-global
          docker_hub_organization: lusotycoon
          quay_io_organization: lusitaniae
          requires:
            - test
            - build
          filters:
            branches:
              only: master
      - prometheus/publish_release:
          context: org-global
          docker_hub_organization: lusotycoon
          quay_io_organization: lusitaniae
          requires:
            - test
            - build
          filters:
            tags:
              only: /^v[0-9]+(\.[0-9]+){2}(-.+|[^-.]*)$/
            branches:
              ignore: /.*/

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start from the shown CircleCI publish_master and publish_release configuration and identify the organization parameters and environment variables third-party exporters need. Document the CI/CD and release process, including Docker and Quay publishing; it is done when an external exporter maintainer can reproduce the setup from the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
ci-cd, devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.