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

Remove namespace from multicluster charts #6665

Merged
merged 1 commit into from
Aug 17, 2021

Conversation

alpeb
Copy link
Member

@alpeb alpeb commented Aug 12, 2021

Another part of #6584, branched off of #6635 (alpeb/no-ns-helm-core).

Stop rendering the namespace in the linkerd-multicluster chart as we
did in #6635.

Also:

  • Got rid of the namespace values.yaml entry in the
    linkerd-multicluster and linkerd-multicluster-link charts, and
    also the installNamespace entry in the former.
  • Added a dependency on the partials chart to the
    linkerd-multicluster-link chart, so that we can tap on the
    partials.namespace helper.
  • Added the post-install hook resources to the linkerd-multicluster
    chart.
  • We don't have any more the restriction on having the muticluster
    objects live in a separate namespace than linkerd. It's still good
    practice, and that's the default for the CLI install, but I removed
    that validation.

Finally, as a side-effect, the allow subcommand was fixed; it has been
broken for a while apparently:

$ linkerd mc allow --service-account-name foobar
Error: template: linkerd-multicluster/templates/remote-access-service-mirror-rbac.yaml:16:7: executing "linkerd-multicluster/templates/remote-access-service-mirror-rbac.yaml" at <include "partials.annotations.created-by" $>: error calling include: template: no template "partials.annotations.created-by" associated with template "gotpl"

Another part of #6584, branched off of #6635 (alpeb/no-ns-helm-core).

Stop rendering the namespace in the `linkerd-multicluster` chart as we
did in #6635.

Also:
- Got rid of the `namespace` values.yaml entry in the
  `linkerd-multicluster` and `linkerd-multicluster-link` charts, and
  also the `installNamespace` entry in the former.
- Added a dependency on the `partials` chart to the
  `linkerd-multicluster-link` chart, so that we can tap on the
  `partials.namespace` helper.
- Added the post-install hook resources to the `linkerd-multicluster`
  chart.
- We don't have any more the restriction on having the muticluster
  objects live in a separate namespace than linkerd. It's still good
  practice, and that's the default for the CLI install, but I removed
  that validation.

Finally, as a side-effect, the `allow` subcommand was fixed; it has been
broken for a while apparently:

```console
$ linkerd mc allow --service-account-name foobar
Error: template: linkerd-multicluster/templates/remote-access-service-mirror-rbac.yaml:16:7: executing "linkerd-multicluster/templates/remote-access-service-mirror-rbac.yaml" at <include "partials.annotations.created-by" $>: error calling include: template: no template "partials.annotations.created-by" associated with template "gotpl"
```
@codecov-commenter
Copy link

Codecov Report

Merging #6665 (7eac2de) into alpeb/no-ns-helm-core (9f6ee44) will decrease coverage by 0.04%.
The diff coverage is 0.00%.

Impacted file tree graph

@@                    Coverage Diff                    @@
##           alpeb/no-ns-helm-core    #6665      +/-   ##
=========================================================
- Coverage                  45.38%   45.33%   -0.05%     
=========================================================
  Files                        182      182              
  Lines                      24440    24266     -174     
  Branches                     290      290              
=========================================================
- Hits                       11091    11001      -90     
+ Misses                     12560    12490      -70     
+ Partials                     789      775      -14     
Flag Coverage Δ
golang 44.02% <0.00%> (-0.06%) ⬇️
javascript 66.76% <ø> (ø)
unittests 45.33% <0.00%> (-0.05%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
pkg/charts/charts.go 11.11% <0.00%> (-0.10%) ⬇️
testutil/test_helper.go 0.00% <0.00%> (ø)
pkg/k8s/labels.go 65.51% <0.00%> (ø)
viz/metrics-api/prometheus.go 82.39% <0.00%> (ø)
controller/api/destination/watcher/test_util.go 76.19% <0.00%> (+1.19%) ⬆️
viz/cmd/stat.go 61.40% <0.00%> (+2.98%) ⬆️
viz/metrics-api/stat_summary.go 87.07% <0.00%> (+4.82%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9f6ee44...7eac2de. Read the comment docs.

Copy link
Contributor

@Pothulapati Pothulapati left a comment

Choose a reason for hiding this comment

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

LGTM.

Finally, as a side-effect, the allow subcommand was fixed; it has been
broken for a while apparently:

Hmm, 🤔 . Do we not have any integration tests this? Could be a good one to raise an issue and let someone try to add it.

Copy link
Contributor

@kleimkuhler kleimkuhler left a comment

Choose a reason for hiding this comment

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

👍

@alpeb alpeb merged commit 11ff9db into alpeb/no-ns-helm-core Aug 17, 2021
@alpeb alpeb deleted the alpeb/no-ns-helm-mc branch August 17, 2021 12:26
@alpeb
Copy link
Member Author

alpeb commented Aug 18, 2021

Finally, as a side-effect, the allow subcommand was fixed; it has been
broken for a while apparently:

Hmm, . Do we not have any integration tests this? Could be a good one to raise an issue and let someone try to add it.

@Pothulapati I've just created #6693 to track that effort.

alpeb added a commit that referenced this pull request Dec 10, 2021
…inkerd-control-plane` (#6635)

Fixes #6584 #6620 #7405

# Namespace Removal

With this change, the `namespace.yaml` template is rendered only for CLI installs and not Helm, and likewise the `namespace:` entry in the namespace-level objects (using a new `partials.namespace` helper).

The `installNamespace` and `namespace` entries in `values.yaml` have been removed.

There in the templates where the namespace is required, we moved from `.Values.namespace` to `.Release.Namespace` which is filled-in automatically by Helm. For the CLI, `install.go` now explicitly defines the contents of the `Release` map alongside `Values`.

The proxy-injector has a new `linkerd-namespace` argument given the namespace is no longer persisted in the `linkerd-config` ConfigMap, so it has to be passed in. To pass it further down to `injector.Inject()` without modifying the `Handler` signature, a closure was used.

------------
Update: Merged-in #6638: Similar changes for the `linkerd-viz` chart:

Stop rendering `namespace.yaml` in the `linkerd-viz` chart.

The additional change here is the addition of the `namespace-metadata.yaml` template (and its RBAC), _not_ rendered in CLI installs, which is a Helm `post-install` hook, consisting on a Job that executes a script adding the required annotations and labels to the viz namespace using a PATCH request against kube-api. The script first checks if the namespace doesn't already have an annotations/labels entries, in which case it has to add extra ops in that patch.

---------
Update: Merged-in the approved #6643, #6665 and #6669 which address the `linkerd2-cni`, `linkerd-multicluster` and `linkerd-jaeger` charts. 

Additional changes from what's already mentioned above:
- Removes the install-namespace option from `linkerd install-cni`, which isn't found in `linkerd install` nor `linkerd viz install` anyways, and it would add some complexity to support.
- Added a dependency on the `partials` chart to the `linkerd-multicluster-link` chart, so that we can tap on the `partials.namespace` helper.
- We don't have any more the restriction on having the muticluster objects live in a separate namespace than linkerd. It's still good practice, and that's the default for the CLI install, but I removed that validation.


Finally, as a side-effect, the `linkerd mc allow` subcommand was fixed; it has been broken for a while apparently:

```console
$ linkerd mc allow --service-account-name foobar
Error: template: linkerd-multicluster/templates/remote-access-service-mirror-rbac.yaml:16:7: executing "linkerd-multicluster/templates/remote-access-service-mirror-rbac.yaml" at <include "partials.annotations.created-by" $>: error calling include: template: no template "partials.annotations.created-by" associated with template "gotpl"
```
---------
Update: see helm/helm#5465 describing the current best-practice

# Core Helm Charts Split

This removes the `linkerd2` chart, and replaces it with the `linkerd-crds` and `linkerd-control-plane` charts. Note that the viz and other extension charts are not concerned by this change.

Also note the original `values.yaml` file has been split into both charts accordingly.

### UX

```console
$ helm install linkerd-crds --namespace linkerd --create-namespace linkerd/linkerd-crds
...
# certs.yaml should contain identityTrustAnchorsPEM and the identity issuer values
$ helm install linkerd-control-plane --namespace linkerd -f certs.yaml linkerd/linkerd-control-plane
```

### Upgrade

As explained in #6635, this is a breaking change. Users will have to uninstall the `linkerd2` chart and install these two, and eventually rollout the proxies (they should continue to work during the transition anyway).

### CLI

The CLI install/upgrade code was updated to be able to pick the templates from these new charts, but the CLI UX remains identical as before.

### Other changes

- The `linkerd-crds` and `linkerd-control-plane` charts now carry a version scheme independent of linkerd's own versioning, as explained in #7405.
- These charts are Helm v3, which is reflected in the `Chart.yaml` entries and in the removal of the `requirements.yaml` files.
- In the integration tests, replaced the `helm-chart` arg with `helm-charts` containing the path `./charts`, used to build the paths for both charts.

### Followups

- Now it's possible to add a `ServiceProfile` instance for Destination in the `linkerd-control-plane` chart.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants