Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactored the examples and rendered directories into one for better usability, #658

Merged
merged 10 commits into from
Feb 9, 2023

Conversation

jvoravong
Copy link
Contributor

This refactor combines the rendered and example directories so they are one. Also added more examples for the most popular use cases.

  • All examples will now be rendered and updated as this project grows.
  • The examples are rendered in parallel.
  • This will help users understand the examples without even downloading the source code and using Helm commands.
  • This can help users understand the differences in each release, especially for some of our more unique Helm value configurations (especially Openshift Security Constraints).

Current Directory Structure:

splunk-otel-collector-chart % tree
.
├── examples
│   ├── README.md
│   ├── add-receiver-creator-values.yaml
│   ├── ...
│   └── use-values.yaml
├── helm-charts
├── rendered
│   ├── README.md
│   ├── manifests
│   │   ├── agent-only
│   │       ├── clusterRole.yaml
│   │       ├── clusterRoleBinding.yaml
│   │       ├── ...
│   │       └── serviceAccount.yaml
│   ├── ....
│   │   └── traces-only
│   │       ├── clusterRole.yaml
│   │       ├── clusterRoleBinding.yaml
│   │       ├── ...
│   │       └── serviceAccount.yaml
│   └── values.yaml
└── test

Refactor Directory Structure:

splunk-otel-collector-chart % tree
.
├── examples
│   ├── README.md
│   ├── add-receiver-creator
│   │   ├── README.md
│   │   ├── add-receiver-creator-values.yaml
│   │   └── rendered_manifests
│   │       ├── clusterRole.yaml
│   │       ├── clusterRoleBinding.yaml
│   │       ├── ...
│   │       └── serviceAccount.yaml
│   ├── ....
│   ├──  use-custom-gateway-values
│   │   ├── README.md
│   │   └── use-custom-gateway-values.yaml
│   │   └── rendered_manifests
│   │       ├── clusterRole.yaml
│   │       ├── clusterRoleBinding.yaml
│   │       ├── ...
│   │       └── serviceAccount.yaml
│   └── use-proxy
│       ├── README.md
│       ├── rendered_manifests
│       └── use-proxy-values.yaml
├── helm-charts
└── test

When reviewing this PR, I'd suggest only reviewing the first commit because all the new rendered yaml files are added in the second commit.

…usability, added more examples, updated related CI/CD files
@jvoravong jvoravong requested review from a team as code owners February 8, 2023 20:22
@jvoravong jvoravong force-pushed the OTL-rendered-examples branch from 8f1e726 to 324527f Compare February 8, 2023 20:36
Copy link
Contributor

@crobert-1 crobert-1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A lot of random little wording nits, sorry if it's a bit overboard! Thanks for the reorganization!

I only reviewed the first commit, as suggested.

examples/add-receiver-creator/README.md Outdated Show resolved Hide resolved
examples/collector-agent-only/README.md Outdated Show resolved Hide resolved
examples/collector-cluster-receiver-only/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/only-logs-fluentd/only-logs-fluentd.yaml Outdated Show resolved Hide resolved
examples/only-logs-fluentd/only-logs-fluentd.yaml Outdated Show resolved Hide resolved
examples/splunk-enterprise-index-routing/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@dmitryax dmitryax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why it's 13k+ changeset? Do we add new examples?

helm-charts/splunk-otel-collector/.helmignore Outdated Show resolved Hide resolved
examples/splunk-enterprise-index-routing/README.md Outdated Show resolved Hide resolved
@dmitryax
Copy link
Contributor

dmitryax commented Feb 8, 2023

Also added more examples for the most popular use cases.

Can you please do that in a follow-up PR and keep this changeset for the refactoring only?

@jvoravong
Copy link
Contributor Author

I was having "make render" render all the examples and place the output k8s manifests into respective subdirectories, that's how this PR got up to +13k. Disabled rendering for now.

Several users keep reaching out for specific rendered Helm Chart files created from different configurations at different versions of the chart. So I would like to ease this pain point.

@dmitryax
Copy link
Contributor

dmitryax commented Feb 9, 2023

I was having "make render" render all the examples and place the output k8s manifests into respective subdirectories, that's how this PR got up to +13k. Disabled rendering for now.

Sorry, I still don't understand why it's such a big changeset if you didn't add any new examples. The rendered files shouldn't be changed significantly, they just moved around, right?

Makefile Show resolved Hide resolved
@dmitryax
Copy link
Contributor

dmitryax commented Feb 9, 2023

LGTM @crobert-1 PTAL

@jvoravong
Copy link
Contributor Author

@crobert-1 the last commit I just added (505ece8)addresses the last of the comments you had.

I'm going to add one more commit now that will re-enable rendering and add back the large number of rendered files.

Copy link
Contributor

@crobert-1 crobert-1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making all of those updates!

@dmitryax dmitryax merged commit 79af98d into signalfx:main Feb 9, 2023
@jvoravong jvoravong deleted the OTL-rendered-examples branch February 9, 2023 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants