diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 500ad4acd..29d244ddb 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,6 +1,6 @@
---
name: Bug Report
-about: Create a report to help us improve Maesh
+about: Create a report to help us improve Traefik Mesh.
---
@@ -29,7 +29,7 @@ HOW TO WRITE A GOOD BUG REPORT?
-### Output of controller log: (_What version of Maesh are you using?_)
+### Output of controller log: (_What version of Traefik Mesh are you using?_)
diff --git a/.gitignore b/.gitignore
index 704127d96..08f45f98b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,11 +9,10 @@
*.log
*.exe
cover.out
-maesh
-!maesh/
+traefik-mesh
/dist/
.vscode
vendor
pages/
-maesh-gh-pages*
+mesh-gh-pages*
*.zip
diff --git a/.goreleaser.yml b/.goreleaser.yml
index 237e4dc3d..8b8c06a3c 100644
--- a/.goreleaser.yml
+++ b/.goreleaser.yml
@@ -1,16 +1,16 @@
-project_name: maesh
+project_name: traefik-mesh
builds:
- - binary: maesh
+ - binary: traefik-mesh
- main: ./cmd/maesh/maesh.go
+ main: ./cmd/mesh/mesh.go
env:
- CGO_ENABLED=0
ldflags:
- -s -w
- - -X github.com/containous/maesh/pkg/version.Version={{.Version}}
- - -X github.com/containous/maesh/pkg/version.Commit={{.Commit}}
- - -X github.com/containous/maesh/pkg/version.Date={{.Date}}
+ - -X github.com/traefik/mesh/pkg/version.Version={{.Version}}
+ - -X github.com/traefik/mesh/pkg/version.Commit={{.Commit}}
+ - -X github.com/traefik/mesh/pkg/version.Date={{.Date}}
goos:
- linux
- freebsd
@@ -30,7 +30,7 @@ builds:
goarch: arm64
archives:
- - id: maesh
+ - id: traefik-mesh
name_template: '{{ .ProjectName }}_v{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}'
format: tar.gz
files:
diff --git a/.semaphore/semaphore.yml b/.semaphore/semaphore.yml
index a9e076133..b7cdcb51f 100644
--- a/.semaphore/semaphore.yml
+++ b/.semaphore/semaphore.yml
@@ -1,5 +1,5 @@
version: v1.0
-name: Maesh Pipeline
+name: Traefik Mesh Pipeline
agent:
machine:
@@ -33,9 +33,9 @@ blocks:
- name: Build and check
commands:
- make check build
- - cache store maesh-dist-$SEMAPHORE_GIT_BRANCH-$SEMAPHORE_WORKFLOW_ID dist
- - docker save containous/maesh:latest > maesh-img.tar
- - cache store maesh-img-$SEMAPHORE_GIT_BRANCH-$SEMAPHORE_WORKFLOW_ID maesh-img.tar
+ - cache store traefik-mesh-dist-$SEMAPHORE_GIT_BRANCH-$SEMAPHORE_WORKFLOW_ID dist
+ - docker save traefik/mesh:latest > traefik-mesh-img.tar
+ - cache store traefik-mesh-img-$SEMAPHORE_GIT_BRANCH-$SEMAPHORE_WORKFLOW_ID traefik-mesh-img.tar
- name: Unit Tests
skip:
@@ -62,9 +62,9 @@ blocks:
- sudo semgo go1.15
- checkout
- cache restore
- - cache restore maesh-dist-$SEMAPHORE_GIT_BRANCH-$SEMAPHORE_WORKFLOW_ID
- - cache restore maesh-img-$SEMAPHORE_GIT_BRANCH-$SEMAPHORE_WORKFLOW_ID
- - docker load < maesh-img.tar
+ - cache restore traefik-mesh-dist-$SEMAPHORE_GIT_BRANCH-$SEMAPHORE_WORKFLOW_ID
+ - cache restore traefik-mesh-img-$SEMAPHORE_GIT_BRANCH-$SEMAPHORE_WORKFLOW_ID
+ - docker load < traefik-mesh-img.tar
jobs:
- name: ACL Enabled Suite
commands:
diff --git a/.travis.yml b/.travis.yml
index 1bf08be54..7a88890a8 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -47,10 +47,10 @@ before_deploy:
if ! [ "$BEFORE_DEPLOY_RUN" ]; then
export BEFORE_DEPLOY_RUN=1;
echo "${DOCKER_PASSWORD}" | docker login -u "${DOCKER_USERNAME}" --password-stdin;
- curl -sfL https://raw.githubusercontent.com/containous/structor/master/godownloader.sh | bash -s -- -b "${GOPATH}/bin" ${STRUCTOR_VERSION};
+ curl -sfL https://raw.githubusercontent.com/traefik/structor/master/godownloader.sh | bash -s -- -b "${GOPATH}/bin" ${STRUCTOR_VERSION};
curl -sSfL https://raw.githubusercontent.com/traefik/mixtus/master/godownloader.sh | sh -s -- -b "${GOPATH}/bin" ${MIXTUS_VERSION};
- structor -o containous -r maesh --dockerfile-url="https://raw.githubusercontent.com/containous/maesh/master/docs/docs.Dockerfile" --menu.js-url="https://raw.githubusercontent.com/containous/structor/master/traefik-menu.js.gotmpl" --rqts-url="https://raw.githubusercontent.com/containous/structor/master/requirements-override.txt" --force-edit-url --exp-branch=master --debug;
- mixtus --dst-doc-path="./mesh" --dst-owner=traefik --dst-repo-name=doc --git-user-email="30906710+traefiker@users.noreply.github.com" --git-user-name=traefiker --src-doc-path="./site" --src-owner=containous --src-repo-name=maesh;
+ structor -o traefik -r mesh --dockerfile-url="https://raw.githubusercontent.com/traefik/mesh/master/docs/docs.Dockerfile" --menu.js-url="https://raw.githubusercontent.com/traefik/structor/master/traefik-menu.js.gotmpl" --rqts-url="https://raw.githubusercontent.com/traefik/structor/master/requirements-override.txt" --force-edit-url --exp-branch=master --debug;
+ mixtus --dst-doc-path="./mesh" --dst-owner=traefik --dst-repo-name=doc --git-user-email="30906710+traefiker@users.noreply.github.com" --git-user-name=traefiker --src-doc-path="./site" --src-owner=traefik --src-repo-name=mesh;
fi
# Copy helm packages
- cp -r pages/charts/. site/charts
@@ -94,5 +94,5 @@ deploy:
skip_cleanup: true
keep_history: true
on:
- repo: containous/maesh
+ repo: traefik/mesh
all_branches: true
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3eefacf8b..75417bc12 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,35 +1,33 @@
# Contributing
-Maesh is an open source project, and your feedback and contributions
-are needed and always welcome.
+Traefik Mesh is an open source project, and your feedback and contributions are needed and always welcome.
-[Issues] and [Pull Requests] are opened at https://github.com/containous/maesh.
+[Issues] and [Pull Requests] are opened at https://github.com/traefik/mesh.
-Non trivial changes should be discussed with the project maintainers by
-opening a [Feature Request] clearly explaining rationale, background
-and possible implementation ideas. Feel free to provide code in such
-discussions.
+Non trivial changes should be discussed with the project maintainers by opening a [Feature Request] clearly explaining rationale,
+background and possible implementation ideas. Feel free to provide code in such discussions.
-Once the proposal is approved, a Pull Request can be opened. If you want
-to provide early visibility to reviewers, create a [Draft Pull Request].
+Once the proposal is approved, a Pull Request can be opened. If you want to provide early visibility to reviewers, create a [Draft Pull Request].
-[Issues]: https://github.com/containous/maesh/issues
-[Pull Requests]: https://github.com/containous/maesh/issues
-[Feature Request]: https://github.com/containous/maesh/issues/new?template=feature_request.md
+[Issues]: https://github.com/traefik/mesh/issues
+[Pull Requests]: https://github.com/traefik/mesh/issues
+[Feature Request]: https://github.com/traefik/mesh/issues/new?template=feature_request.md
[Draft Pull Request]: https://github.blog/2019-02-14-introducing-draft-pull-requests/
## Release Process
-Maesh follows the [semver](https://semver.org/) scheme when releasing new versions.
+Traefik Mesh follows the [semver](https://semver.org/) scheme when releasing new versions.
-Therefore, all PR's (except fixing a bug in a specific version) should be made against the `master` branch. If you're attempting to fix a bug in an already released version, please use the correct branch of that release (e.g. `v1.1`). All bug-fixes made to a specific branch will be backported to master, prior to releasing a new (major / minor) version. Patch releases will be made out of the version branch.
+Therefore, all PR's (except fixing a bug in a specific version) should be made against the `master` branch.
+If you're attempting to fix a bug in an already released version, please use the correct branch of that release (e.g. `v1.1`).
+All bug-fixes made to a specific branch will be backported to master, prior to releasing a new (major / minor) version. Patch releases will be made out of the version branch.
### Release steps
-In order to release a new version of Maesh, the following steps have to be done:
+In order to release a new version of Traefik Mesh, the following steps have to be done:
* Create a Prepare release PR updating the chart version and app version to upcoming release
-* Prepare a list of release notes for the #maesh
+* Prepare a list of release notes for the #traefik-mesh
* Merge Prepare release PR
* Create and push a tag on the release commit
-* Create a new release branch (v1.x) on upstream to allow versioned docs to be built
\ No newline at end of file
+* Create a new release branch (v1.x) on upstream to allow versioned docs to be built
diff --git a/Dockerfile b/Dockerfile
index 637b52fcc..235923541 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,4 +1,3 @@
-# Let's build maesh for linux-amd64
FROM golang:1.15-alpine AS base-image
# Package dependencies
@@ -16,7 +15,7 @@ RUN apk --no-cache --no-progress add \
&& update-ca-certificates \
&& rm -rf /var/cache/apk/*
-WORKDIR /go/src/github.com/containous/maesh
+WORKDIR /go/src/github.com/traefik/mesh
# Download goreleaser binary to bin folder in $GOPATH
RUN curl -sfL https://install.goreleaser.com/github.com/goreleaser/goreleaser.sh | sh
@@ -42,6 +41,6 @@ RUN addgroup -g 1000 -S app && \
adduser -u 1000 -S app -G app
COPY --from=base-image /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
-COPY --from=maker /go/src/github.com/containous/maesh/dist/maesh /app/
+COPY --from=maker /go/src/github.com/traefik/mesh/dist/traefik-mesh /app/
-ENTRYPOINT ["/app/maesh"]
+ENTRYPOINT ["/app/traefik-mesh"]
diff --git a/LICENSE b/LICENSE
index 59d479ee9..253cb5383 100644
--- a/LICENSE
+++ b/LICENSE
@@ -186,7 +186,8 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.
- Copyright 2019 Containous SAS
+ Copyright 2020 Containous SAS
+ Copyright 2020 Traefik Labs
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/Makefile b/Makefile
index 8c346a892..2c0908c65 100644
--- a/Makefile
+++ b/Makefile
@@ -1,11 +1,11 @@
-DOCKER_IMAGE_NAME := containous/maesh
+DOCKER_IMAGE_NAME := traefik/mesh
UNAME := $(shell uname)
SRCS = $(shell git ls-files '*.go' | grep -v '^vendor/')
-BINARY_NAME = maesh
+BINARY_NAME = traefik-mesh
DIST_DIR = $(CURDIR)/dist
-DIST_DIR_MAESH = $(DIST_DIR)/$(BINARY_NAME)
-PROJECT ?= github.com/containous/$(BINARY_NAME)
+DIST_DIR_TRAEFIK_MESH = $(DIST_DIR)/$(BINARY_NAME)
+PROJECT ?= github.com/traefik/mesh
TAG_NAME ?= $(shell git tag -l --contains HEAD)
SHA := $(shell git rev-parse --short HEAD)
@@ -22,7 +22,7 @@ $(DIST_DIR):
mkdir -p $(DIST_DIR)
clean:
- rm -rf $(CURDIR)/dist/ cover.out $(CURDIR)/pages $(CURDIR)/gh-pages.zip $(CURDIR)/maesh-gh-pages
+ rm -rf $(CURDIR)/dist/ cover.out $(CURDIR)/pages $(CURDIR)/gh-pages.zip $(CURDIR)/mesh-gh-pages
# Static linting of source files. See .golangci.toml for options
local-check: $(DIST_DIR) helm-lint
@@ -30,11 +30,11 @@ local-check: $(DIST_DIR) helm-lint
# Local commands
local-build: $(DIST_DIR)
- CGO_ENABLED=0 go build -o ${DIST_DIR_MAESH} -ldflags="-s -w \
- -X github.com/containous/$(BINARY_NAME)/pkg/version.Version=$(VERSION) \
- -X github.com/containous/$(BINARY_NAME)/pkg/version.Commit=$(SHA) \
- -X github.com/containous/$(BINARY_NAME)/pkg/version.Date=$(BUILD_DATE)" \
- $(CURDIR)/cmd/$(BINARY_NAME)/*.go
+ CGO_ENABLED=0 go build -o ${DIST_DIR_TRAEFIK_MESH} -ldflags="-s -w \
+ -X github.com/traefik/mesh/pkg/version.Version=$(VERSION) \
+ -X github.com/traefik/mesh/pkg/version.Commit=$(SHA) \
+ -X github.com/traefik/mesh/pkg/version.Date=$(BUILD_DATE)" \
+ $(CURDIR)/cmd/mesh/mesh.go
local-test: clean
go test -v -cover ./...
@@ -105,19 +105,19 @@ helm:
@command -v helm >/dev/null 2>&1 || curl -L https://git.io/get_helm.sh | bash -s -- -v v3.0.1
helm-lint: helm
- helm lint helm/chart/maesh
+ helm lint helm/chart/mesh
k3d:
@command -v k3d >/dev/null 2>&1 || curl -s https://raw.githubusercontent.com/rancher/k3d/v3.0.1/install.sh | TAG=v3.0.1 bash
pages:
mkdir -p $(CURDIR)/pages
- rm -rf $(CURDIR)/gh-pages.zip $(CURDIR)/maesh-gh-pages
+ rm -rf $(CURDIR)/gh-pages.zip $(CURDIR)/mesh-gh-pages
curl -sSLO https://$(PROJECT)/archive/gh-pages.zip
unzip $(CURDIR)/gh-pages.zip
# We only keep the directory "charts" so documentation may remove files
- cp -r $(CURDIR)/maesh-gh-pages/charts $(CURDIR)/pages/
- rm -rf $(CURDIR)/gh-pages.zip $(CURDIR)/maesh-gh-pages
+ cp -r $(CURDIR)/mesh-gh-pages/charts $(CURDIR)/pages/
+ rm -rf $(CURDIR)/gh-pages.zip $(CURDIR)/mesh-gh-pages
docs-package: pages
make -C $(CURDIR)/docs
@@ -125,8 +125,8 @@ docs-package: pages
cp $(CURDIR)/docs/CNAME $(CURDIR)/pages/CNAME
helm-package: helm-lint pages
- helm package --app-version $(TAG_NAME) $(CURDIR)/helm/chart/maesh
- cp helm/chart/maesh/README.md index.md
+ helm package --app-version $(TAG_NAME) $(CURDIR)/helm/chart/mesh
+ cp helm/chart/mesh/README.md index.md
mkdir -p $(CURDIR)/pages/charts
mv *.tgz index.md $(CURDIR)/pages/charts/
helm repo index $(CURDIR)/pages/charts/
diff --git a/README.md b/README.md
index 9d612ccc9..c2cab4e5d 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,22 @@
-
+
-[](https://travis-ci.com/containous/maesh)
-[](https://containous.semaphoreci.com/projects/maesh)
+[](https://travis-ci.com/traefik/mesh)
+[](https://traefik.semaphoreci.com/projects/mesh)
[](https://docs.mae.sh)
-[](https://goreportcard.com/report/github.com/containous/maesh)
-[](https://github.com/containous/maesh/releases)
-[](https://github.com/containous/maesh/blob/master/LICENSE)
+[](https://goreportcard.com/report/github.com/traefik/mesh)
+[](https://github.com/traefik/mesh/releases)
+[](https://github.com/traefik/mesh/blob/master/LICENSE)
[](https://community.containo.us/c/maesh)
-## Maesh: Simpler Service Mesh
+## Traefik Mesh: Simpler Service Mesh
-Maesh is a simple, yet full-featured service mesh.
+Traefik Mesh is a simple, yet full-featured service mesh.
It is container-native and fits as your de-facto service mesh in your Kubernetes cluster.
It supports the latest Service Mesh Interface specification [SMI](https://smi-spec.io) that facilitates integration with pre-existing solution.
-Moreover, Maesh is opt-in by default,
-which means that your existing services are unaffected until you decide to add them to the mesh.
+Moreover, Traefik Mesh is opt-in by default, which means that your existing services are unaffected until you decide to add them to the mesh.
@@ -26,15 +25,15 @@ which means that your existing services are unaffected until you decide to add t
## Non-Invasive Service Mesh
-Maesh does not use any sidecar container but handles routing through proxy endpoints running on each node.
+Traefik Mesh does not use any sidecar container but handles routing through proxy endpoints running on each node.
The mesh controller runs in a dedicated pod and handles all the configuration parsing and deployment to the proxy nodes.
-Maesh supports multiple configuration options: annotations on user service objects, and SMI objects.
-Not using sidecars means that Maesh does not modify your Kubernetes objects, and does not modify your traffic without your knowledge.
-Using the Maesh endpoints is all that is required.
+Traefik Mesh supports multiple configuration options: annotations on user service objects, and SMI objects.
+Not using sidecars means that Traefik Mesh does not modify your Kubernetes objects, and does not modify your traffic without your knowledge.
+Using the Traefik Mesh endpoints is all that is required.
-
-
+
+
## Prerequisites
@@ -48,9 +47,9 @@ To run this app, you require the following:
## Install (Helm v3 only)
```shell
-helm repo add maesh https://containous.github.io/maesh/charts
+helm repo add traefik-mesh https://traefik.github.io/mesh/charts
helm repo update
-helm install maesh maesh/maesh
+helm install traefik-mesh traefik-mesh/traefik-mesh
```
You can find the complete documentation at https://docs.mae.sh.
diff --git a/cmd/cleanup/cleanup.go b/cmd/cleanup/cleanup.go
index fdf102332..78059dd9f 100644
--- a/cmd/cleanup/cleanup.go
+++ b/cmd/cleanup/cleanup.go
@@ -4,9 +4,9 @@ import (
"context"
"fmt"
- "github.com/containous/maesh/cmd"
- "github.com/containous/maesh/pkg/cleanup"
- "github.com/containous/maesh/pkg/k8s"
+ "github.com/traefik/mesh/cmd"
+ "github.com/traefik/mesh/pkg/cleanup"
+ "github.com/traefik/mesh/pkg/k8s"
"github.com/traefik/paerser/cli"
)
@@ -14,7 +14,7 @@ import (
func NewCmd(cConfig *cmd.CleanupConfiguration, loaders []cli.ResourceLoader) *cli.Command {
return &cli.Command{
Name: "cleanup",
- Description: `Removes Maesh shadow services from a Kubernetes cluster.`,
+ Description: `Removes Traefik Mesh shadow services from a Kubernetes cluster.`,
Configuration: cConfig,
Run: func(_ []string) error {
return cleanupCommand(cConfig)
@@ -31,7 +31,7 @@ func cleanupCommand(cConfig *cmd.CleanupConfiguration) error {
return fmt.Errorf("could not create logger: %w", err)
}
- logger.Debug("Starting maesh cleanup...")
+ logger.Debug("Starting cleanup...")
logger.Debugf("Using masterURL: %q", cConfig.MasterURL)
logger.Debugf("Using kubeconfig: %q", cConfig.KubeConfig)
diff --git a/cmd/configuration.go b/cmd/configuration.go
index b05a50270..7766b3c96 100644
--- a/cmd/configuration.go
+++ b/cmd/configuration.go
@@ -4,8 +4,8 @@ import (
"os"
)
-// MaeshConfiguration wraps the static configuration and extra parameters.
-type MaeshConfiguration struct {
+// TraefikMeshConfiguration wraps the static configuration and extra parameters.
+type TraefikMeshConfiguration struct {
ConfigFile string `description:"Configuration file to use. If specified all other flags are ignored." export:"true"`
KubeConfig string `description:"Path to a kubeconfig. Only required if out-of-cluster." export:"true"`
MasterURL string `description:"The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster." export:"true"`
@@ -15,7 +15,7 @@ type MaeshConfiguration struct {
ACL bool `description:"Enable ACL mode." export:"true"`
SMI bool `description:"Enable SMI operation, deprecated, use --acl instead." export:"true"`
DefaultMode string `description:"Default mode for mesh services." export:"true"`
- Namespace string `description:"The namespace that maesh is installed in." export:"true"`
+ Namespace string `description:"The namespace that Traefik Mesh is installed in." export:"true"`
WatchNamespaces []string `description:"Namespaces to watch." export:"true"`
IgnoreNamespaces []string `description:"Namespaces to ignore." export:"true"`
APIPort int32 `description:"API port for the controller." export:"true"`
@@ -25,9 +25,9 @@ type MaeshConfiguration struct {
LimitUDPPort int32 `description:"Number of UDP ports allocated." export:"true"`
}
-// NewMaeshConfiguration creates a MaeshConfiguration with default values.
-func NewMaeshConfiguration() *MaeshConfiguration {
- return &MaeshConfiguration{
+// NewTraefikMeshConfiguration creates a TraefikMeshConfiguration with default values.
+func NewTraefikMeshConfiguration() *TraefikMeshConfiguration {
+ return &TraefikMeshConfiguration{
ConfigFile: "",
KubeConfig: os.Getenv("KUBECONFIG"),
LogLevel: "error",
@@ -53,7 +53,7 @@ type PrepareConfiguration struct {
LogLevel string `description:"The log level." export:"true"`
LogFormat string `description:"The log format." export:"true"`
Debug bool `description:"Debug mode, deprecated, use --loglevel=debug instead." export:"true"`
- Namespace string `description:"The namespace that maesh is installed in." export:"true"`
+ Namespace string `description:"The namespace that Traefik Mesh is installed in." export:"true"`
ClusterDomain string `description:"Your internal K8s cluster domain." export:"true"`
SMI bool `description:"Enable SMI operation, deprecated, use --acl instead." export:"true"`
ACL bool `description:"Enable ACL mode." export:"true"`
@@ -77,7 +77,7 @@ type CleanupConfiguration struct {
ConfigFile string `description:"Configuration file to use. If specified all other flags are ignored." export:"true"`
KubeConfig string `description:"Path to a kubeconfig. Only required if out-of-cluster." export:"true"`
MasterURL string `description:"The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster." export:"true"`
- Namespace string `description:"The namespace that maesh is installed in." export:"true"`
+ Namespace string `description:"The namespace that Traefik Mesh is installed in." export:"true"`
LogLevel string `description:"The log level." export:"true"`
LogFormat string `description:"The log format." export:"true"`
}
diff --git a/cmd/loaders.go b/cmd/loaders.go
index a8747ae7d..f986df8e8 100644
--- a/cmd/loaders.go
+++ b/cmd/loaders.go
@@ -14,21 +14,39 @@ import (
"github.com/traefik/paerser/parser"
)
-const maeshPrefix = "MAESH_"
+const (
+ meshPrefix = "MESH_"
+ maeshPrefix = "MAESH_"
+ traefikMeshPrefix = "TRAEFIK_MESH_"
+)
-// EnvLoader loads a configuration from all the environment variables prefixed with "MAESH_".
+// EnvLoader loads a configuration from all the environment variables.
type EnvLoader struct{}
-// Load loads the command's configuration from the environment variables.
+// Load loads the command's configuration from the environment variables prefixed with "TRAEFIK_MESH_" or "MAESH_".
+// The "MAESH_" prefix is deprecated and will be removed in the next major release.
+// If "TRAEFIK_MESH_" and "MAESH_" env variables are mixed up an error is returned.
+// As it is not possible to have a prefix with multiple "_" everything is normalized to "MESH_" under the hood for the decoding.
func (e *EnvLoader) Load(_ []string, cmd *cli.Command) (bool, error) {
logger := logrus.StandardLogger()
- vars := env.FindPrefixedEnvVars(os.Environ(), maeshPrefix, cmd.Configuration)
+ traefikMeshVars := findAndNormalizePrefixedEnvVars(traefikMeshPrefix, cmd.Configuration)
+ maeshVars := findAndNormalizePrefixedEnvVars(maeshPrefix, cmd.Configuration)
+
+ if len(maeshVars) > 0 && len(traefikMeshVars) > 0 {
+ return false, fmt.Errorf("environment variable prefixed by %q cannot be mixed with variable prefixed by %q", maeshPrefix, traefikMeshPrefix)
+ }
+
+ vars := traefikMeshVars
+ if len(maeshVars) > 0 {
+ vars = maeshVars
+ }
+
if len(vars) == 0 {
return false, nil
}
- if err := env.Decode(vars, maeshPrefix, cmd.Configuration); err != nil {
+ if err := env.Decode(vars, meshPrefix, cmd.Configuration); err != nil {
logger.Debug("environment variables", strings.Join(vars, ", "))
return false, fmt.Errorf("failed to decode configuration from environment variables: %w ", err)
}
@@ -38,6 +56,16 @@ func (e *EnvLoader) Load(_ []string, cmd *cli.Command) (bool, error) {
return true, nil
}
+func findAndNormalizePrefixedEnvVars(prefix string, config interface{}) []string {
+ vars := env.FindPrefixedEnvVars(os.Environ(), prefix, config)
+
+ for _, v := range vars {
+ vars = append(vars, strings.Replace(v, prefix, meshPrefix, 1))
+ }
+
+ return vars
+}
+
// FileLoader loads a configuration from a file.
type FileLoader struct{}
@@ -72,9 +100,13 @@ func (f *FileLoader) Load(args []string, cmd *cli.Command) (bool, error) {
// loadConfigFiles tries to decode the given configuration file and all default locations for the configuration file.
// It stops as soon as decoding one of them is successful.
+// The default maesh locations are deprecated and will be removed in a future major release.
func loadConfigFiles(configFile string, element interface{}) (string, error) {
finder := cli.Finder{
- BasePaths: []string{"/etc/maesh/maesh", "$XDG_CONFIG_HOME/maesh", "$HOME/.config/maesh", "./maesh"},
+ BasePaths: []string{
+ "/etc/maesh/maesh", "$XDG_CONFIG_HOME/maesh", "$HOME/.config/maesh", "./maesh",
+ "/etc/traefik-mesh/traefik-mesh", "$XDG_CONFIG_HOME/traefik-mesh", "$HOME/.config/traefik-mesh", "./traefik-mesh",
+ },
Extensions: []string{"toml", "yaml", "yml"},
}
diff --git a/cmd/maesh/maesh.go b/cmd/mesh/mesh.go
similarity index 74%
rename from cmd/maesh/maesh.go
rename to cmd/mesh/mesh.go
index 1da6a10d1..68a6d1a47 100644
--- a/cmd/maesh/maesh.go
+++ b/cmd/mesh/mesh.go
@@ -9,14 +9,14 @@ import (
"sync"
"time"
- "github.com/containous/maesh/cmd"
- "github.com/containous/maesh/cmd/cleanup"
- "github.com/containous/maesh/cmd/prepare"
- "github.com/containous/maesh/cmd/version"
- "github.com/containous/maesh/pkg/api"
- "github.com/containous/maesh/pkg/controller"
- "github.com/containous/maesh/pkg/k8s"
"github.com/sirupsen/logrus"
+ "github.com/traefik/mesh/cmd"
+ "github.com/traefik/mesh/cmd/cleanup"
+ "github.com/traefik/mesh/cmd/prepare"
+ "github.com/traefik/mesh/cmd/version"
+ "github.com/traefik/mesh/pkg/api"
+ "github.com/traefik/mesh/pkg/controller"
+ "github.com/traefik/mesh/pkg/k8s"
"github.com/traefik/paerser/cli"
)
@@ -27,37 +27,37 @@ const (
)
func main() {
- maeshConfig := cmd.NewMaeshConfiguration()
- maeshLoaders := []cli.ResourceLoader{&cmd.FileLoader{}, &cli.FlagLoader{}, &cmd.EnvLoader{}}
-
- cmdMaesh := &cli.Command{
- Name: "maesh",
- Description: `maesh`,
- Configuration: maeshConfig,
- Resources: maeshLoaders,
+ traefikMeshConfig := cmd.NewTraefikMeshConfiguration()
+ traefikMeshLoaders := []cli.ResourceLoader{&cmd.FileLoader{}, &cli.FlagLoader{}, &cmd.EnvLoader{}}
+
+ cmdTraefikMesh := &cli.Command{
+ Name: "traefik-mesh",
+ Description: `traefik-mesh`,
+ Configuration: traefikMeshConfig,
+ Resources: traefikMeshLoaders,
Run: func(_ []string) error {
- return maeshCommand(maeshConfig)
+ return traefikMeshCommand(traefikMeshConfig)
},
}
prepareConfig := cmd.NewPrepareConfiguration()
- if err := cmdMaesh.AddCommand(prepare.NewCmd(prepareConfig, maeshLoaders)); err != nil {
+ if err := cmdTraefikMesh.AddCommand(prepare.NewCmd(prepareConfig, traefikMeshLoaders)); err != nil {
stdlog.Println(err)
os.Exit(1)
}
cleanupConfig := cmd.NewCleanupConfiguration()
- if err := cmdMaesh.AddCommand(cleanup.NewCmd(cleanupConfig, maeshLoaders)); err != nil {
+ if err := cmdTraefikMesh.AddCommand(cleanup.NewCmd(cleanupConfig, traefikMeshLoaders)); err != nil {
stdlog.Println(err)
os.Exit(1)
}
- if err := cmdMaesh.AddCommand(version.NewCmd()); err != nil {
+ if err := cmdTraefikMesh.AddCommand(version.NewCmd()); err != nil {
stdlog.Println(err)
os.Exit(1)
}
- if err := cli.Execute(cmdMaesh); err != nil {
+ if err := cli.Execute(cmdTraefikMesh); err != nil {
stdlog.Println(err)
os.Exit(1)
}
@@ -65,7 +65,7 @@ func main() {
os.Exit(0)
}
-func maeshCommand(config *cmd.MaeshConfiguration) error {
+func traefikMeshCommand(config *cmd.TraefikMeshConfiguration) error {
ctx := cmd.ContextWithSignal(context.Background())
log, err := cmd.NewLogger(config.LogFormat, config.LogLevel, config.Debug)
@@ -73,7 +73,7 @@ func maeshCommand(config *cmd.MaeshConfiguration) error {
return fmt.Errorf("could not create logger: %w", err)
}
- log.Debug("Starting maesh controller...")
+ log.Debug("Starting controller...")
log.Debugf("Using masterURL: %q", config.MasterURL)
log.Debugf("Using kubeconfig: %q", config.KubeConfig)
diff --git a/cmd/prepare/prepare.go b/cmd/prepare/prepare.go
index 57e0df5d6..63ae2d00b 100644
--- a/cmd/prepare/prepare.go
+++ b/cmd/prepare/prepare.go
@@ -4,9 +4,9 @@ import (
"context"
"fmt"
- "github.com/containous/maesh/cmd"
- "github.com/containous/maesh/pkg/dns"
- "github.com/containous/maesh/pkg/k8s"
+ "github.com/traefik/mesh/cmd"
+ "github.com/traefik/mesh/pkg/dns"
+ "github.com/traefik/mesh/pkg/k8s"
"github.com/traefik/paerser/cli"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
@@ -32,7 +32,7 @@ func prepareCommand(pConfig *cmd.PrepareConfiguration) error {
return fmt.Errorf("could not create logger: %w", err)
}
- log.Debug("Starting maesh prepare...")
+ log.Debug("Starting prepare...")
log.Debugf("Using masterURL: %q", pConfig.MasterURL)
log.Debugf("Using kubeconfig: %q", pConfig.KubeConfig)
diff --git a/cmd/version/version.go b/cmd/version/version.go
index e580a4ed0..8a545b7df 100644
--- a/cmd/version/version.go
+++ b/cmd/version/version.go
@@ -4,7 +4,7 @@ import (
"fmt"
"runtime"
- "github.com/containous/maesh/pkg/version"
+ "github.com/traefik/mesh/pkg/version"
"github.com/traefik/paerser/cli"
)
@@ -21,7 +21,7 @@ platform : %s/%s
func NewCmd() *cli.Command {
return &cli.Command{
Name: "version",
- Description: `Shows the current Maesh version.`,
+ Description: `Shows the current Traefik Mesh version.`,
Configuration: nil,
Run: func(_ []string) error {
printVersion()
diff --git a/docs/CNAME b/docs/CNAME
index fc6d2320d..8b1378917 100644
--- a/docs/CNAME
+++ b/docs/CNAME
@@ -1 +1 @@
-docs.mae.sh
+
diff --git a/docs/Makefile b/docs/Makefile
index 0c8da3829..72af8fce9 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,12 +1,12 @@
#######
-# This Makefile contains all targets related to the documentation
+# This Makefile contains all targets related to the documentation.
#######
DOCS_VERIFY_SKIP ?= false
DOCS_LINT_SKIP ?= false
-MAESH_DOCS_BUILD_IMAGE ?= maesh-docs
-MAESH_DOCS_CHECK_IMAGE ?= $(MAESH_DOCS_BUILD_IMAGE)-check
+TRAEFIK_MESH_DOCS_BUILD_IMAGE ?= traefik-mesh-docs
+TRAEFIK_MESH_DOCS_CHECK_IMAGE ?= $(TRAEFIK_MESH_DOCS_BUILD_IMAGE)-check
SITE_DIR := $(CURDIR)/site
@@ -19,28 +19,28 @@ docs: clean image lint build verify
# Writer Mode: build and serve docs on http://localhost:8000 with livereload
serve: image
- docker run $(DOCKER_RUN_DOC_OPTS) $(MAESH_DOCS_BUILD_IMAGE) mkdocs serve
+ docker run $(DOCKER_RUN_DOC_OPTS) $(TRAEFIK_MESH_DOCS_BUILD_IMAGE) mkdocs serve
# Utilities Targets for each step
image:
- docker build -t $(MAESH_DOCS_BUILD_IMAGE) -f docs.Dockerfile ./
+ docker build -t $(TRAEFIK_MESH_DOCS_BUILD_IMAGE) -f docs.Dockerfile ./
build: image
- docker run $(DOCKER_RUN_DOC_OPTS) $(MAESH_DOCS_BUILD_IMAGE) sh -c "mkdocs build \
+ docker run $(DOCKER_RUN_DOC_OPTS) $(TRAEFIK_MESH_DOCS_BUILD_IMAGE) sh -c "mkdocs build \
&& chown -R $(shell id -u):$(shell id -g) ./site"
verify: build
@if [ "$(DOCS_VERIFY_SKIP)" != "true" ]; then \
- docker build -t $(MAESH_DOCS_CHECK_IMAGE) -f check.Dockerfile ./; \
- docker run --rm -v $(CURDIR):/app $(MAESH_DOCS_CHECK_IMAGE) /verify.sh; \
+ docker build -t $(TRAEFIK_MESH_DOCS_CHECK_IMAGE) -f check.Dockerfile ./; \
+ docker run --rm -v $(CURDIR):/app $(TRAEFIK_MESH_DOCS_CHECK_IMAGE) /verify.sh; \
else \
echo "DOCS_VERIFY_SKIP is true: no verification done."; \
fi
lint:
@if [ "$(DOCS_LINT_SKIP)" != "true" ]; then \
- docker build -t $(MAESH_DOCS_CHECK_IMAGE) -f check.Dockerfile ./ && \
- docker run --rm -v $(CURDIR):/app $(MAESH_DOCS_CHECK_IMAGE) /lint.sh; \
+ docker build -t $(TRAEFIK_MESH_DOCS_CHECK_IMAGE) -f check.Dockerfile ./ && \
+ docker run --rm -v $(CURDIR):/app $(TRAEFIK_MESH_DOCS_CHECK_IMAGE) /lint.sh; \
else \
echo "DOCS_LINT_SKIP is true: no linting done."; \
fi
diff --git a/docs/content/api.md b/docs/content/api.md
index 682baf83d..117283526 100644
--- a/docs/content/api.md
+++ b/docs/content/api.md
@@ -1,7 +1,7 @@
# API
-Maesh includes a built-in API that can be used for debugging purposes.
-This can be useful when Maesh is not working as intended.
+Traefik Mesh includes a built-in API that can be used for debugging purposes.
+This can be useful when Traefik Mesh is not working as intended.
The API is accessed via the controller pod, and for security reasons is not exposed via service.
The API can be accessed by making a `GET` request to `http://:9000` combined with one of the following paths:
@@ -14,16 +14,16 @@ This endpoint provides raw json of the current configuration built by the contro
## `/api/status/nodes`
-This endpoint provides a json array containing some details about the readiness of the Maesh nodes visible by the controller
+This endpoint provides a json array containing some details about the readiness of the Traefik Mesh nodes visible by the controller.
This endpoint will still return a 200 if there are no visible nodes.
-## `/api/status/node/{maesh-pod-name}/configuration`
+## `/api/status/node/{traefik-mesh-pod-name}/configuration`
-This endpoint provides raw json of the current configuration on the Maesh node with the pod name given in `{maesh-pod-name}`.
+This endpoint provides raw json of the current configuration on the Traefik Mesh node with the pod name given in `{traefik-mesh-pod-name}`.
This endpoint provides a 404 response if the pod cannot be found, or other non-200 status codes on other errors.
If errors are encountered, the error will be returned in the body, and logged on the controller.
## `/api/status/readiness`
-This endpoint returns a 200 response if the controller successfully deployed a configuration to all Maesh nodes, and Maesh
-is ready for use. Otherwise, it will return a 500.
+This endpoint returns a 200 response if the controller has successfully started.
+Otherwise, it will return a 500.
diff --git a/docs/content/assets/img/after-maesh-graphic.png b/docs/content/assets/img/after-traefik-mesh-graphic.png
similarity index 100%
rename from docs/content/assets/img/after-maesh-graphic.png
rename to docs/content/assets/img/after-traefik-mesh-graphic.png
diff --git a/docs/content/assets/img/after-maesh-graphic.svg b/docs/content/assets/img/after-traefik-mesh-graphic.svg
similarity index 100%
rename from docs/content/assets/img/after-maesh-graphic.svg
rename to docs/content/assets/img/after-traefik-mesh-graphic.svg
diff --git a/docs/content/assets/img/before-maesh-graphic.png b/docs/content/assets/img/before-traefik-mesh-graphic.png
similarity index 100%
rename from docs/content/assets/img/before-maesh-graphic.png
rename to docs/content/assets/img/before-traefik-mesh-graphic.png
diff --git a/docs/content/assets/img/before-maesh-graphic.svg b/docs/content/assets/img/before-traefik-mesh-graphic.svg
similarity index 100%
rename from docs/content/assets/img/before-maesh-graphic.svg
rename to docs/content/assets/img/before-traefik-mesh-graphic.svg
diff --git a/docs/content/assets/img/maesh-logo.svg b/docs/content/assets/img/traefik-mesh-logo.svg
similarity index 100%
rename from docs/content/assets/img/maesh-logo.svg
rename to docs/content/assets/img/traefik-mesh-logo.svg
diff --git a/docs/content/assets/img/maesh.logo.horizontal.png b/docs/content/assets/img/traefik-mesh.logo.horizontal.png
similarity index 100%
rename from docs/content/assets/img/maesh.logo.horizontal.png
rename to docs/content/assets/img/traefik-mesh.logo.horizontal.png
diff --git a/docs/content/assets/img/maesh.png b/docs/content/assets/img/traefik-mesh.png
similarity index 100%
rename from docs/content/assets/img/maesh.png
rename to docs/content/assets/img/traefik-mesh.png
diff --git a/docs/content/compatibility.md b/docs/content/compatibility.md
index acaca0b5b..a4a1a39a9 100644
--- a/docs/content/compatibility.md
+++ b/docs/content/compatibility.md
@@ -1,18 +1,19 @@
# Compatibility
-Maesh supports [similiar to Kubernetes](https://kubernetes.io/docs/setup/release/version-skew-policy/#supported-versions) at least the latest 3 minor versions of Kubernetes, therefore currently:
+Traefik Mesh supports, [similar to Kubernetes](https://kubernetes.io/docs/setup/release/version-skew-policy/#supported-versions), at least the latest three minor versions of Kubernetes, therefore currently:
* 1.17
* 1.18
* 1.19
-General functionality can not be guaranted for versions older than that. However, we expect it to work with Kubernetes down to 1.11 currently.
+General functionality cannot be guaranted for versions older than that. However, we expect it to work with Kubernetes down to 1.11 currently.
## Compatibility by Features
-Some of Maesh's features are only supported on certain Kubernetes versions. Please see the table below.
+Some of Traefik Mesh's features are only supported on certain Kubernetes versions.
+Please see the table below.
- | Features | K8s 1.17 | K8s 1.18 | K8s 1.19 |
- |-----------------------|----------|----------|----------|
- | General functionality | ✔ | ✔ | ✔ |
- | Service Topology | ✔ | ✔ | ✔ |
+| Features | K8s 1.17 | K8s 1.18 | K8s 1.19 |
+|-----------------------|----------|----------|----------|
+| General functionality | ✔ | ✔ | ✔ |
+| Service Topology | ✔ | ✔ | ✔ |
diff --git a/docs/content/configuration.md b/docs/content/configuration.md
index 8e3c4faa2..b2146d58b 100644
--- a/docs/content/configuration.md
+++ b/docs/content/configuration.md
@@ -1,6 +1,6 @@
# Configuration
-The configuration for Maesh is broken down into two parts: the static configuration, and the dynamic configuration.
+The configuration for Traefik Mesh is broken down into two parts: the static configuration, and the dynamic configuration.
The static configuration is configured when the service mesh is installed and is configured via the `values.yaml` file in the Helm install.
## Static configuration
@@ -15,13 +15,13 @@ The static configuration is configured when the service mesh is installed and is
- Tracing can be enabled.
- Access-Control List (ACL) mode can be enabled.
- This configures Maesh to run in ACL mode, where all traffic is forbidden unless explicitly allowed via an SMI
+ This configures Traefik Mesh to run in ACL mode, where all traffic is forbidden unless explicitly allowed via an SMI
[TrafficTarget](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md#traffictarget). Please see
the [SMI Specification](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md) for more information.
## Dynamic configuration
-Dynamic configuration can be provided to Maesh using annotations on Kubernetes services and via SMI objects.
+Dynamic configuration can be provided to Traefik Mesh using annotations on Kubernetes services and via SMI objects.
| Features | ACL disabled | ACL enabled |
|-----------------------|--------------|-------------|
@@ -35,14 +35,14 @@ Dynamic configuration can be provided to Maesh using annotations on Kubernetes s
### Kubernetes Service Annotations
-Annotations on services give the ability to configure how Maesh interprets them.
+Annotations on services give the ability to configure how Traefik Mesh interprets them.
#### Traffic type
The traffic type can be configured by using the following annotation:
```yaml
-maesh.containo.us/traffic-type: "http"
+mesh.traefik.io/traffic-type: "http"
```
This annotation can be set to either `http`, `tcp` or `udp` and will specifies the mode for that service operation.
@@ -58,32 +58,32 @@ If this annotation is not present, the mesh service will operate in the default
The scheme used to define custom scheme for request:
```yaml
-maesh.containo.us/scheme: "h2c"
+mesh.traefik.io/scheme: "h2c"
```
-This annotation can be set to either `http`, `https` or `h2c` and is available for `maesh.containo.us/traffic-type: "http"`.
+This annotation can be set to either `http`, `https` or `h2c` and is available for `mesh.traefik.io/traffic-type: "http"`.
??? Note "Limitations"
Please keep in mind, that if you set the scheme to `https` your service needs to expose itself via HTTPS as there is no
- mTLS in Maesh.
+ mTLS in Traefik Mesh.
#### Retry
Retries can be enabled by using the following annotation:
```yaml
-maesh.containo.us/retry-attempts: "2"
+mesh.traefik.io/retry-attempts: "2"
```
-This annotation sets the number of retry attempts that Maesh will make if a network error occurs.
+This annotation sets the number of retry attempts that Traefik Mesh will make if a network error occurs.
Please note that this value is a string, and needs to be quoted.
#### Circuit breaker
-
+
Circuit breaker can be enabled by using the following annotation:
```yaml
-maesh.containo.us/circuit-breaker-expression: "Expression"
+mesh.traefik.io/circuit-breaker-expression: "Expression"
```
This annotation sets the expression for circuit breaking.
@@ -97,8 +97,8 @@ All configuration options are available [here](https://docs.traefik.io/v2.0/midd
Rate limiting can be enabled by using the following annotations:
```yaml
-maesh.containo.us/ratelimit-average: "100"
-maesh.containo.us/ratelimit-burst: "200"
+mesh.traefik.io/ratelimit-average: "100"
+mesh.traefik.io/ratelimit-burst: "200"
```
These annotation sets average and burst requests per second limit for the service.
@@ -170,7 +170,7 @@ spec:
In this example, we grant access to all pods running with the service account `client` under the namespace `client` to the HTTP route `api` specified by on the group `server-routes` on all pods running with the service account `server` under the namespace `server`.
-Any client running with the service account `client` under the `client` namespace accessing `server.server.maesh/api` is allowed to access the `/api` resource. Others will receive 404 answers from the Maesh node.
+Any client running with the service account `client` under the `client` namespace accessing `server.server.traefik.mesh/api` is allowed to access the `/api` resource. Others will receive 404 answers from the Traefik Mesh node.
More information can be found [in the SMI specification](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md).
@@ -194,10 +194,10 @@ spec:
```
In this example, we define a traffic split for our server service between two versions of our server, v1 and v2.
-`server.server.maesh` directs 80% of the traffic to the server-v1 pods, and 20% of the traffic to the server-v2 pods.
+`server.server.traefik.mesh` directs 80% of the traffic to the server-v1 pods, and 20% of the traffic to the server-v2 pods.
More information can be found [in the SMI specification](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md).
#### Traffic Metrics
-At the moment, Maesh does not implement the [Traffic Metrics specification](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-metrics/traffic-metrics-WD.md).
+At the moment, Traefik Mesh does not implement the [Traffic Metrics specification](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-metrics/traffic-metrics-WD.md).
diff --git a/docs/content/contributing/building-testing.md b/docs/content/contributing/building-testing.md
index bf4a79c7c..fea9cfe36 100644
--- a/docs/content/contributing/building-testing.md
+++ b/docs/content/contributing/building-testing.md
@@ -1,22 +1,22 @@
# Building and Testing
-So you want to build your own Maesh binary from the sources? Let's see how.
+So you want to build your own Traefik Mesh binary from the sources? Let's see how.
## Building
-To build Maesh from the sources you need either [Docker](https://github.com/docker/docker) and [make](https://www.gnu.org/software/make/manual/make.html),
+To build Traefik Mesh from the sources you need either [Docker](https://github.com/docker/docker) and [make](https://www.gnu.org/software/make/manual/make.html),
or [Go](https://github.com/golang/go).
### With `Docker` and `make`
-Maesh can be built from the sources by using the `make` command. This will create a binary for the Linux platform in
-the `dist` directory and a Docker image:
+Traefik Mesh can be built from the sources by using the `make` command.
+This will create a binary for the Linux platform in the `dist` directory and a Docker image:
```bash
$ make
#[...]
-Successfully tagged containous/maesh:latest
-docker run --name=build -t "containous/maesh:latest" version
+Successfully tagged traefik/mesh:latest
+docker run --name=build -t "traefik/mesh:latest" version
version:
version : b417901
commit : b417901
@@ -27,7 +27,7 @@ version:
#[...]
$ ls dist/
-maesh
+traefik-mesh
```
!!! Note
@@ -40,12 +40,12 @@ Requirements:
- `Go` v1.14+
- Environment variable `GO111MODULE=on`
-One your Go environment is set up, you can build Maesh from the sources by using the `go build` command. The Go compiler
-will build an executable for your platform.
+One your Go environment is set up, you can build Traefik Mesh from the sources by using the `go build` command.
+The Go compiler will build an executable for your platform.
```bash
-$ go build -o dist/maesh cmd/maesh/*.go
-$ ./dist/maesh version
+$ go build -o dist/traefik-mesh cmd/mesh/mesh.go
+$ ./dist/traefik-mesh version
version:
version : dev
commit : I don't remember exactly
@@ -63,18 +63,18 @@ Run unit tests by using the `test` target:
```bash
$ make test
-docker build --tag "containous/maesh:test" --target maker --build-arg="MAKE_TARGET=local-test" /home/user/maesh/
+docker build --tag "traefik/mesh:test" --target maker --build-arg="MAKE_TARGET=local-test" /home/user/traefik-mesh/
#[...]
--- PASS: TestBuildConfiguration (0.00s)
--- PASS: TestBuildConfiguration/simple_configuration_build_with_HTTP_service (0.20s)
PASS
coverage: 69.7% of statements
-ok github.com/containous/maesh/pkg/providers/smi 1.982s coverage: 69.7% of statements
-? github.com/containous/maesh/pkg/signals [no test files]
+ok github.com/traefik/mesh/pkg/providers/smi 1.982s coverage: 69.7% of statements
+? github.com/traefik/mesh/pkg/signals [no test files]
Removing intermediate container 4e887c16ddee
---> 75d44229a46e
Successfully built 75d44229a46e
-Successfully tagged containous/maesh:test
+Successfully tagged traefik/mesh:test
```
Run the integration tests by using the `test-integration` target. For development purposes, you can specify which tests
@@ -117,8 +117,8 @@ time="2020-04-09T16:09:16+04:00" level=debug msg="Found trafficsplits for servic
--- PASS: TestBuildConfiguration (0.00s)
--- PASS: TestBuildConfiguration/simple_configuration_build_with_HTTP_service (0.21s)
PASS
-ok github.com/containous/maesh/pkg/providers/smi 3.634s
-? github.com/containous/maesh/pkg/signals [no test files]
+ok github.com/traefik/mesh/pkg/providers/smi 3.634s
+? github.com/traefik/mesh/pkg/signals [no test files]
```
Run the integration tests in the `integration` directory by using the `go test ./integration -integration` command:
@@ -129,9 +129,9 @@ $ go test -v ./integration -integration -check.f HelmSuite
OK: 2 passed
--- PASS: Test (161.20s)
PASS
-ok github.com/containous/maesh/integration 162.695s
+ok github.com/traefik/mesh/integration 162.695s
```
!!! Important
- Before running the integration tests, build the Maesh Docker image. Check out the [Building](#building) section for
- more details.
+ Before running the integration tests, build the Traefik Mesh Docker image.
+ Check out the [Building](#building) section for more details.
diff --git a/docs/content/contributing/documentation.md b/docs/content/contributing/documentation.md
index 94e46895f..9e245a151 100644
--- a/docs/content/contributing/documentation.md
+++ b/docs/content/contributing/documentation.md
@@ -13,9 +13,9 @@ You can build the documentation and test it locally (with live reloading), using
```bash
$ make serve
-docker build -t maesh-docs -f docs.Dockerfile ./
+docker build -t traefik-mesh-docs -f docs.Dockerfile ./
# […]
-docker run --rm -v /Users/kevinpollet/Documents/Dev/maesh/docs:/mkdocs -p 8000:8000 maesh-docs mkdocs serve
+docker run --rm -v /home/user/traefik-mesh/docs:/mkdocs -p 8000:8000 traefik-mesh-docs mkdocs serve
# […]
INFO - Building documentation...
INFO - Cleaning site directory
@@ -66,9 +66,9 @@ If you've made changes to the documentation, it's safer to clean it before verif
```bash
$ make clean verify
-docker build -t maesh-docs -f docs.Dockerfile ./
+docker build -t traefik-mesh-docs -f docs.Dockerfile ./
# […]
-docker run --rm -v /Users/kevinpollet/Documents/Dev/maesh/docs:/mkdocs -p 8000:8000 maesh-docs sh -c "mkdocs build && chown -R 501:20 ./site"
+docker run --rm -v /home/user/traefik-mesh/docs:/mkdocs -p 8000:8000 traefik-mesh-docs sh -c "mkdocs build && chown -R 501:20 ./site"
=== Checking HTML content...
# […]
```
diff --git a/docs/content/contributing/submitting-issues.md b/docs/content/contributing/submitting-issues.md
index dd6bfdb3c..9b53dda20 100644
--- a/docs/content/contributing/submitting-issues.md
+++ b/docs/content/contributing/submitting-issues.md
@@ -1,13 +1,13 @@
# Submitting Issues
-We use the [GitHub issue tracker](https://github.com/containous/maesh/issues) to keep track of Maesh issues.
+We use the [GitHub issue tracker](https://github.com/traefik/mesh/issues) to keep track of Traefik Mesh issues.
The process of sorting and checking the issues requires a lot of work. To save us some time and get quicker feedback,
be sure to follow the guidelines below.
!!! Important "Getting Help"
- The issue tracker is not a general support forum, but a place to report bugs and asks for new features. For end-user
- related support questions, use the [Maesh community forum](https://community.containo.us/c/maesh/15).
+ The issue tracker is not a general support forum, but a place to report bugs and asks for new features.
+ For end-user related support questions, use the [Traefik Mesh community forum](https://community.containo.us/c/maesh).
## Issue Title
@@ -15,7 +15,7 @@ The title must be short and descriptive. (~60 characters)
## Description
-Follow the [issue template](https://github.com/containous/maesh/blob/master/.github/ISSUE_TEMPLATE/) as much as possible.
+Follow the [issue template](https://github.com/traefik/mesh/blob/master/.github/ISSUE_TEMPLATE/) as much as possible.
Explain in which context you encountered the issue.
@@ -28,9 +28,9 @@ what matters, and help them understand the structure of your message (see the [G
Remember, when asking for new features, they must be useful to the majority (and not only useful in edge case scenarios, or hack-like setups).
-Do your best to explain what you're looking for, and why it would improve Maesh for everyone.
+Do your best to explain what you're looking for, and why it would improve Traefik Mesh for everyone.
## International English
-Maesh maintainers/users are not all native English speakers, so if you sometimes feel that some messages sound rude,
+Traefik Mesh maintainers/users are not all native English speakers, so if you sometimes feel that some messages sound rude,
remember that it's probably a language barrier problem from someone willing to help you.
diff --git a/docs/content/contributing/submitting-pull-requests.md b/docs/content/contributing/submitting-pull-requests.md
index fbad1a89b..fc30f02a3 100644
--- a/docs/content/contributing/submitting-pull-requests.md
+++ b/docs/content/contributing/submitting-pull-requests.md
@@ -1,6 +1,6 @@
# Submitting Pull Requests
-So you've decided to improve Maesh? Thank You! Now the last step is to submit your Pull Request in a way that makes sure
+So you've decided to improve Traefik Mesh? Thank You! Now the last step is to submit your Pull Request in a way that makes sure
it gets the attention it deserves.
Let's go through the classic pitfalls to make sure everything is right.
@@ -11,7 +11,7 @@ The title must be short and descriptive. (~60 characters)
## Description
-Follow the [pull request template](https://github.com/containous/maesh/blob/master/.github/PULL_REQUEST_TEMPLATE.md)
+Follow the [pull request template](https://github.com/traefik/mesh/blob/master/.github/PULL_REQUEST_TEMPLATE.md)
as much as possible.
Explain the conditions which led you to write this PR: give us context. The context should lead to something, an idea or
diff --git a/docs/content/contributing/thank-you.md b/docs/content/contributing/thank-you.md
index 4f0441295..fe25ab4d0 100644
--- a/docs/content/contributing/thank-you.md
+++ b/docs/content/contributing/thank-you.md
@@ -1,6 +1,6 @@
# Thank You!
-Maesh is an [open-source project](https://github.com/containous/maesh/), your feedback and contributions are needed and
+Traefik Mesh is an [open-source project](https://github.com/traefik/mesh/), your feedback and contributions are needed and
always welcome!
!!! Question "Where to Go Next?"
@@ -10,7 +10,7 @@ always welcome!
read the page [Submitting Issues](./submitting-issues.md).
- Discover how to make an efficient contribution,
read the page [Submitting Pull Requests](./submitting-pull-requests.md).
- - Learn how to build and test Maesh,
+ - Learn how to build and test Traefik Mesh,
the page [Building and Testing](./building-testing.md) is for you.
- Contribute to the documentation,
read the related page [Documentation](./documentation.md).
diff --git a/docs/content/examples.md b/docs/content/examples.md
index e42d523b4..8016d37c7 100644
--- a/docs/content/examples.md
+++ b/docs/content/examples.md
@@ -1,9 +1,9 @@
# Examples
-Here are some examples on how to easily deploy Maesh on your cluster.
+Here are some examples on how to easily deploy Traefik Mesh on your cluster.
??? Note "Prerequisites"
- Before following those examples, make sure your cluster follows [the prerequisites for deploying Maesh](quickstart.md#prerequisites).
+ Before following those examples, make sure your cluster follows [the prerequisites for deploying Traefik Mesh](quickstart.md#prerequisites).
## Simple Example
@@ -50,7 +50,7 @@ spec:
serviceAccount: whoami-server
containers:
- name: whoami
- image: containous/whoami:v1.4.0
+ image: traefik/whoami:latest
imagePullPolicy: IfNotPresent
---
@@ -72,7 +72,7 @@ spec:
serviceAccount: whoami-server
containers:
- name: whoami-tcp
- image: containous/whoamitcp:latest
+ image: traefik/whoamitcp:latest
imagePullPolicy: IfNotPresent
---
@@ -174,13 +174,13 @@ my data
Received: my data
```
-You can now install Maesh [by following this documentation](install.md) on your cluster.
+You can now install Traefik Mesh [by following this documentation](install.md) on your cluster.
-Since Maesh is not intrusive, it has to be explicitly given access to services before it can be used. You can ensure that the HTTP endpoint of your service does not pass through Maesh since no `X-Forwarded-For` header should be added.
+Since Traefik Mesh is not intrusive, it has to be explicitly given access to services before it can be used. You can ensure that the HTTP endpoint of your service does not pass through Traefik Mesh since no `X-Forwarded-For` header should be added.
-Now, in order to configure Maesh for your `whoami` service, you just need to update the `whoami` service specs, in order to add the appropriate annotations.
+Now, in order to configure Traefik Mesh for your `whoami` service, you just need to update the `whoami` service specs, in order to add the appropriate annotations.
-The HTTP service needs to have `maesh.containo.us/traffic-type: "http"` and the TCP service, `maesh.containo.us/traffic-type: "tcp"`.
+The HTTP service needs to have `mesh.traefik.io/traffic-type: "http"` and the TCP service, `mesh.traefik.io/traffic-type: "tcp"`.
```yaml
---
@@ -191,10 +191,9 @@ metadata:
namespace: whoami
labels:
app: whoami
- # These annotations enable Maesh for this service:
annotations:
- maesh.containo.us/traffic-type: "http"
- maesh.containo.us/retry-attempts: "2"
+ mesh.traefik.io/traffic-type: "http"
+ mesh.traefik.io/retry-attempts: "2"
spec:
type: ClusterIP
ports:
@@ -211,9 +210,8 @@ metadata:
namespace: whoami
labels:
app: whoami-tcp
- # These annotations enable Maesh for this service:
annotations:
- maesh.containo.us/traffic-type: "tcp"
+ mesh.traefik.io/traffic-type: "tcp"
spec:
type: ClusterIP
ports:
@@ -223,10 +221,10 @@ spec:
app: whoami-tcp
```
-You should now be able to access your HTTP and TCP services through the Maesh endpoint:
+You should now be able to access your HTTP and TCP services through the Traefik Mesh endpoint:
```bash tab="Command"
-kubectl -n whoami exec whoami-client -- curl -s whoami.whoami.maesh
+kubectl -n whoami exec whoami-client -- curl -s whoami.whoami.traefik.mesh
```
```text tab="Expected Output"
@@ -235,7 +233,7 @@ IP: 127.0.0.1
IP: 5.6.7.8
RemoteAddr: 1.2.3.4:12345
GET / HTTP/1.1
-Host: whoami.whoami.maesh
+Host: whoami.whoami.traefik.mesh
User-Agent: curl/7.64.0
Accept: */*
X-Forwarded-For: 3.4.5.6
@@ -243,12 +241,12 @@ X-Forwarded-For: 3.4.5.6
## ACL Example
-The [ACL mode](install.md#access-control-list) can be enabled when installing Maesh. Once activated, all traffic is forbidden unless explicitly authorized
-using the SMI [TrafficTarget](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md#traffictarget) resource. This example will present the configuration required to allow the client
-pod to send traffic to the HTTP and TCP services defined in the previous example.
+The [ACL mode](install.md#access-control-list) can be enabled when installing Traefik Mesh.
+Once activated, all traffic is forbidden unless explicitly authorized using the SMI [TrafficTarget](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md#traffictarget) resource.
+This example will present the configuration required to allow the client pod to send traffic to the HTTP and TCP services defined in the previous example.
-Each `TrafficTarget` defines that a set of source `ServiceAccount` is capable of sending traffic to a destination `ServiceAccount`. To authorize the `whoami-client` pod to send traffic to `whoami.whoami.maesh`, we need to
-explicitly allow it to hit the pods exposed by the `whoami` service.
+Each `TrafficTarget` defines that a set of source `ServiceAccount` is capable of sending traffic to a destination `ServiceAccount`.
+To authorize the `whoami-client` pod to send traffic to `whoami.whoami.traefik.mesh`, we need to explicitly allow it to hit the pods exposed by the `whoami` service.
```yaml
---
diff --git a/docs/content/index.md b/docs/content/index.md
index fcd1434e7..6a9b1fefb 100644
--- a/docs/content/index.md
+++ b/docs/content/index.md
@@ -1,14 +1,14 @@
-# Maesh: Simpler Service Mesh
+# Traefik Mesh: Simpler Service Mesh
-
+
-Maesh is a lightweight and simpler service mesh designed from the ground up to be straightforward, easy to install and easy to use.
+Traefik Mesh is a lightweight and simpler service mesh designed from the ground up to be straightforward, easy to install and easy to use.
-Built on top of Traefik, Maesh fits as your de-facto service mesh in your Kubernetes cluster supporting the latest Service Mesh Interface specification (SMI).
+Built on top of Traefik, Traefik Mesh fits as your de-facto service mesh in your Kubernetes cluster supporting the latest Service Mesh Interface specification (SMI).
-Moreover, Maesh is opt-in by default, which means that your existing services are unaffected until you decide to add them to the mesh.
+Moreover, Traefik Mesh is opt-in by default, which means that your existing services are unaffected until you decide to add them to the mesh.
@@ -16,15 +16,15 @@ Moreover, Maesh is opt-in by default, which means that your existing services ar
## Non-Invasive Service Mesh
-Maesh does not use any sidecar container but handles routing through proxy endpoints running on each node.
+Traefik Mesh does not use any sidecar container but handles routing through proxy endpoints running on each node.
The mesh controller runs in a dedicated pod and handles all the configuration parsing and deployment to the proxy nodes.
-Maesh supports multiple configuration options: annotations on user service objects, and SMI objects.
-Not using sidecars means that Maesh does not modify your Kubernetes objects and does not modify your traffic without your knowledge.
-Using the Maesh endpoints is all that is required.
+Traefik Mesh supports multiple configuration options: annotations on user service objects, and SMI objects.
+Not using sidecars means that Traefik Mesh does not modify your Kubernetes objects and does not modify your traffic without your knowledge.
+Using the Traefik Mesh endpoints is all that is required.
-
-
+
+
## Prerequisites
diff --git a/docs/content/install.md b/docs/content/install.md
index f5d11d02c..d9fd92d6c 100644
--- a/docs/content/install.md
+++ b/docs/content/install.md
@@ -1,23 +1,23 @@
# Installation
-To install Maesh, the installation method is quite simple:
+To install Traefik Mesh, the installation method is quite simple:
```bash
-helm repo add maesh https://containous.github.io/maesh/charts
+helm repo add traefik-mesh https://traefik.github.io/mesh/charts
helm repo update
```
-Install Maesh Helm Chart:
+Install Traefik Mesh Helm Chart:
```bash
-helm install maesh maesh/maesh
+helm install traefik-mesh traefik-mesh/traefik-mesh
```
## Install from source
!!! Note "Supported Installations"
Please be aware that the supported installation method is via Helm, using official releases.
- If you want to build/install/run Maesh from source, we may not be able to provide support.
+ If you want to build/install/run Traefik Mesh from source, we may not be able to provide support.
Installing from source is intended for development/contributing.
To build the image locally, run:
@@ -33,40 +33,39 @@ You will then be able to use the tagged image as your image in your `values.yaml
To deploy the Helm Chart, run:
```shell
-helm install maesh helm/chart/maesh --set controller.image.pullPolicy=IfNotPresent --set controller.image.tag=latest
+helm install traefik-mesh helm/chart/mesh --set controller.image.pullPolicy=IfNotPresent --set controller.image.tag=latest
```
## KubeDNS support
-Maesh supports KubeDNS:
+Traefik Mesh supports KubeDNS:
```bash
-helm install maesh maesh/maesh --set kubedns=true
+helm install traefik-mesh traefik-mesh/traefik-mesh --set kubedns=true
```
-With the `kubedns` parameter Maesh will install CoreDNS and patch KubeDNS to use it as a [stubDomain](https://v1-17.docs.kubernetes.io/docs/tasks/administer-cluster/dns-custom-nameservers/#example-stub-domain).
+With the `kubedns` parameter Traefik Mesh will install CoreDNS and patch KubeDNS to use it as a [stubDomain](https://v1-17.docs.kubernetes.io/docs/tasks/administer-cluster/dns-custom-nameservers/#example-stub-domain).
## Custom cluster domain
If you use a cluster domain other than `cluster.local` set it by using the `clusterDomain` parameter:
```bash
-helm install maesh maesh/maesh --set clusterDomain=my.custom.domain.com
+helm install traefik-mesh traefik-mesh/traefik-mesh --set clusterDomain=my.custom.domain.com
```
## Access Control List
-By default, Maesh does not restrict traffic between pods and services. However, some scenarios require more control
-over the rules for internal communication. The Access Control List mode (ACL) requires a set of rules to explicitly allow
-traffic between different resources.
+By default, Traefik Mesh does not restrict traffic between pods and services. However, some scenarios require more control over the rules for internal communication.
+The Access Control List mode (ACL) requires a set of rules to explicitly allow traffic between different resources.
-To enable ACL, install Maesh in ACL mode by setting the `acl` Helm Chart option to `true`.
+To enable ACL, install Traefik Mesh in ACL mode by setting the `acl` Helm Chart option to `true`.
```bash
-helm install maesh --namespace=maesh maesh/maesh --set acl=true
+helm install traefik-mesh --namespace=traefik-mesh traefik-mesh/traefik-mesh --set acl=true
```
-Maesh supports the [SMI specification](https://smi-spec.io/) which defines a set of custom resources
+Traefik Mesh supports the [SMI specification](https://smi-spec.io/) which defines a set of custom resources
to provide a fine-grained control over instrumentation, routing and access control of east-west communications.
!!! Note "CRDs"
@@ -77,45 +76,45 @@ to provide a fine-grained control over instrumentation, routing and access contr
## Platform recommendations
-Maesh works on Kubernetes environments that conforms to the global Kubernetes specification.
+Traefik Mesh works on Kubernetes environments that conforms to the global Kubernetes specification.
That being said, we have had users encounter issues when using variants such as minikube, microk8s,
and other development distributions.
-Maesh runs without issue on most public clouds (AWS, GKE, Azure, DigitalOcean, and more).
-If you want to run Maesh in development, we would recommend using [k3s](https://k3s.io/), as it is fully conformant.
-We use k3s in Maesh's integration tests, so you can be sure that it works properly.
+Traefik Mesh runs without issue on most public clouds (AWS, GKE, Azure, DigitalOcean, and more).
+If you want to run Traefik Mesh in development, we would recommend using [k3s](https://k3s.io/), as it is fully conformant.
+We use k3s in Traefik Mesh's integration tests, so you can be sure that it works properly.
If you encounter issues on variants such as minikube or microk8s, please try and reproduce the issue on k3s.
If you are unable to reproduce, it may be an issue with the distribution behaving differently than official Kubernetes.
## Verify your installation
-You can check that Maesh has been installed properly by running the following command:
+You can check that Traefik Mesh has been installed properly by running the following command:
```bash tab="Command"
-kubectl get all -n maesh
+kubectl get all -n traefik-mesh
```
```text tab="Expected Output"
-NAME READY STATUS RESTARTS AGE
-pod/maesh-controller-676fb86b89-pj8ph 1/1 Running 0 11s
-pod/maesh-mesh-w62z5 1/1 Running 0 11s
-pod/maesh-mesh-zjlpf 1/1 Running 0 11s
+NAME READY STATUS RESTARTS AGE
+pod/traefik-mesh-controller-676fb86b89-pj8ph 1/1 Running 0 11s
+pod/traefik-mesh-proxy-w62z5 1/1 Running 0 11s
+pod/traefik-mesh-proxy-zjlpf 1/1 Running 0 11s
-NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE
-daemonset.apps/maesh-mesh 2 2 0 2 0 29s
+NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE
+daemonset.apps/traefik-mesh-proxy 2 2 0 2 0 29s
-NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
-deployment.apps/maesh-controller 1 1 1 0 28s
+NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
+deployment.apps/traefik-mesh-controller 1 1 1 0 28s
-NAME DESIRED CURRENT READY AGE
-replicaset.apps/maesh-controller-676fb86b89 1 1 0 28s
+NAME DESIRED CURRENT READY AGE
+replicaset.apps/traefik-mesh-controller-676fb86b89 1 1 0 28s
```
## Usage
-To use Maesh, instead of referencing services via their normal `.`, instead use `..maesh`.
-This will access the Maesh service mesh, and will allow you to route requests through Maesh.
+To use Traefik Mesh, instead of referencing services via their normal `.`, instead use `..traefik.mesh`.
+This will access the Traefik Mesh service mesh, and will allow you to route requests through Traefik Mesh.
-By default, Maesh is opt-in, meaning you have to use the Maesh service names to access the mesh, so you can have some services running through the mesh, and some services not.
+By default, Traefik Mesh is opt-in, meaning you have to use the Traefik Mesh service names to access the mesh, so you can have some services running through the mesh, and some services not.
diff --git a/docs/content/migration/helm-chart.md b/docs/content/migration/helm-chart.md
index bd82fda3e..7403b3d27 100644
--- a/docs/content/migration/helm-chart.md
+++ b/docs/content/migration/helm-chart.md
@@ -5,44 +5,52 @@ Helm Chart
## v2.1 to v3.0
+### Traefik Mesh renaming
+
+All existing resources have been renamed and prefixed by `traefik-mesh`.
+For example, the `maesh-controller`resource has been renamed to `traefik-mesh-controller`.
+
+### Mesh Property Name
+
+Inside the Traefik Mesh helm chart, the `mesh` property has been renamed to `proxy`.
+
### Image version
-Since version `v1.4`, Maesh uses plain [Traefik](https://github.com/containous/traefik/) Docker image for mesh proxies.
-Therefore, to change the image version used for the controller, or the mesh proxies you should use the `controller.image`
-and `mesh.image` options.
+Since version `v1.4`, Traefik Mesh uses plain [Traefik](https://github.com/traefik/traefik/) Docker image for proxies.
+Therefore, to change the image version used for the controller, or the proxies you should use the `controller.image` and `proxy.image` options.
+
+### Default Mode
+
+The `mesh.defaultMode` option has been removed.
+You should use the new `defaultMode` option to configure the default traffic mode.
## v2.0 to v2.1
### Default Mode
The `mesh.defaultMode` option has been deprecated and will be removed in a future major release.
-You should use the new `defaultMode` option to configure the default traffic mode for Maesh services.
+You should use the new `defaultMode` option to configure the default traffic mode.
### Prometheus and Grafana services
-Prior to version `v2.1`, when the Metrics chart is deployed, Prometheus and Grafana services are exposed by default through
-a `NodePort`. For security reasons, those services are not exposed by default anymore. To expose them you should use the
-new `prometheus.service` and `grafana.service` options, more details in the corresponding [values.yaml](https://github.com/containous/maesh/blob/e59b861ac91261b950663410a6223a02fc7e2290/helm/chart/maesh/charts/metrics/values.yaml).
+Prior to version `v2.1`, when the Metrics chart is deployed, Prometheus and Grafana services are exposed by default through a `NodePort`.
+For security reasons, those services are not exposed by default anymore.
+To expose them you should use the new `prometheus.service` and `grafana.service` options, more details in the corresponding [values.yaml](https://github.com/traefik/mesh/blob/e59b861ac91261b950663410a6223a02fc7e2290/helm/chart/maesh/charts/metrics/values.yaml).
## v1.x to v2.0
-### Default Mode
-
-The `mesh.defaultMode` option has been removed. You should use the new `defaultMode` option to configure the default traffic
-mode for Maesh services.
-
### Image version
-Since version `v1.2`, Maesh uses [Traefik](https://github.com/containous/traefik/) as a library and does not rely on its
-Docker image anymore. Therefore, the `controller.image` and `mesh.image` options have been removed. You should use the
-new `image` option as described in the [documentation](../install.md#deploy-helm-chart).
+Since version `v1.2`, [Traefik](https://github.com/traefik/traefik/) is used as a library.
+Therefore, the `controller.image` and `mesh.image` options have been removed.
+You should use the new `image` option as described in the [documentation](../install.md#deploy-helm-chart).
### Log Level
-The `controller.logging.debug` and `mesh.logging` options have been removed. You should use the new `controller.logLevel`
-and `mesh.logLevel` options to configure the logging level for the controller and proxies.
+The `controller.logging.debug` and `mesh.logging` options have been removed.
+You should use the new `controller.logLevel` and `mesh.logLevel` options to configure the logging level for the controller and proxies.
### SMI Mode
-The `smi.enable` option has been deprecated and removed. You should use the new and backward compatible ACL mode
-option as described in the [documentation](../install.md#access-control-list).
+The `smi.enable` option has been deprecated and removed.
+You should use the new and backward compatible ACL mode option as described in the [documentation](../install.md#access-control-list).
diff --git a/docs/content/migration/maesh-v1.md b/docs/content/migration/maesh-v1.md
deleted file mode 100644
index d6db975ec..000000000
--- a/docs/content/migration/maesh-v1.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# Minor Migrations
-
-Maesh v1
-{: .subtitle }
-
-## v1.1 to v1.2
-
-### Debug
-
-The `--debug` CLI flag is deprecated and will be removed in a future major release. Instead, you should use the new
-`--logLevel` flag with `debug` as value.
-
-### SMI Mode
-
-The `--smi` CLI flag is deprecated and will be removed in a future major release. Instead, you should use the new and
-backward compatible `--acl` flag.
diff --git a/docs/content/migration/traefik-mesh-v1.md b/docs/content/migration/traefik-mesh-v1.md
new file mode 100644
index 000000000..e3cf7223e
--- /dev/null
+++ b/docs/content/migration/traefik-mesh-v1.md
@@ -0,0 +1,55 @@
+# Minor Migrations
+
+Traefik Mesh v1
+{: .subtitle }
+
+## Traefik Mesh v1.4
+
+Maesh has been renamed to Traefik Mesh in an effort to rename all of our products and make them look closer.
+Through this renaming process, a couple of things changed which might be worth mentioning for a migration process.
+All areas that changed are mentioned below with the appropriate actions needed to do.
+
+Everything called Maesh references to `v1.3`, while Traefik Mesh refers to `v1.4`.
+
+### Environment Variable Prefix
+
+Prior to Traefik Mesh, environment variables were prefixed with `MAESH_`.
+Now they're prefixed with `TRAEFIK_MESH_` and the `MAESH_` prefix is deprecated.
+You need to decide on either using `MAESH_` or `TRAEFIK_MESH_` as mixing both will result in an error.
+
+### Configuration File Name
+
+The default configuration file name is changed from `maesh` to `traefik-mesh` as well.
+
+### DNS Name
+
+The well known internal DNS name, to opt in into the usage of Maesh was `.maesh`.
+Now, with the rebranding process this has been changed to `traefik.mesh` and thus, you now need to use the DNS name of `servicename.servicenamespace.traefik.maesh` to opt-in into the usage of Traefik Mesh.
+The old name `.maesh`, is deprecated and will be removed eventually.
+
+### Docker Image Name
+
+As part of the process, the docker-image has been moved from `containous/maesh` to `traefik/mesh`.
+The old image will not be updated anymore and `traefik/mesh` starts with `v1.4.0`.
+
+### Binary
+
+The new binary name is `traefik-mesh`, rather than `maesh` before.
+However, as Traefik Mesh is running inside k8s this change should not be critical as it's hidden by the docker-image name.
+
+### Annotations
+
+As part of the rebranding process, the annotation prefix has changed.
+The annotation prefix `maesh.containo.us/` has been deprecated in favour of `mesh.traefik.io`.
+
+## v1.1 to v1.2
+
+### Debug
+
+The `--debug` CLI flag is deprecated and will be removed in a future major release.
+Instead, you should use the new `--logLevel` flag with `debug` as value.
+
+### SMI Mode
+
+The `--smi` CLI flag is deprecated and will be removed in a future major release.
+Instead, you should use the new and backward compatible `--acl` flag.
diff --git a/docs/content/quickstart.md b/docs/content/quickstart.md
index e55b3f0d0..ffb918277 100644
--- a/docs/content/quickstart.md
+++ b/docs/content/quickstart.md
@@ -1,6 +1,6 @@
# Quickstart
-Maesh can be installed in your cluster without affecting any running services.
+Traefik Mesh can be installed in your cluster without affecting any running services.
It can safely be installed using the [Helm Chart](https://helm.sh/docs/intro/using_helm/#helm-install-installing-a-package).
## Prerequisites
@@ -11,15 +11,12 @@ It can safely be installed using the [Helm Chart](https://helm.sh/docs/intro/usi
### RBAC
-Depending on the tool you used to deploy your cluster you might need
-to tweak RBAC permissions.
+Depending on the tool you used to deploy your cluster you might need to tweak RBAC permissions.
#### `kubeadm`
-If you used `kubeadm` to deploy your cluster, a fast way to allow the
-helm installation to perform all steps it needs is to edit the
-`cluster-admin` `ClusterRoleBinding`, adding the following to the
-`subjects` section:
+If you used `kubeadm` to deploy your cluster, a fast way to allow the helm installation to perform all steps it needs is to edit the
+`cluster-admin` `ClusterRoleBinding`, adding the following to the `subjects` section:
```yaml
- kind: ServiceAccount
@@ -27,31 +24,31 @@ helm installation to perform all steps it needs is to edit the
namespace: kube-system
```
-## Installing Maesh
+## Installing Traefik Mesh
```bash tab="Command"
-helm repo add maesh https://containous.github.io/maesh/charts
+helm repo add traefik-mesh https://traefik.github.io/mesh/charts
helm repo update
-helm install maesh maesh/maesh
+helm install traefik-mesh traefik-mesh/traefik-mesh
```
```bash tab="Expected output"
[...]
NOTES:
-Thank you for installing maesh.
+Thank you for installing traefik-mesh.
-Your release is named maesh.
+Your release is named traefik-mesh.
To learn more about the release, try:
- $ helm status maesh
- $ helm get maesh
+ $ helm status traefik-mesh
+ $ helm get traefik-mesh
```
-## Using Maesh
+## Using Traefik Mesh
-As an example, let's deploy a server application and a client application under the `maesh-test` namespace.
+As an example, let's deploy a server application and a client application under the `test` namespace.
```yaml tab="server.yaml"
---
@@ -59,7 +56,7 @@ apiVersion: apps/v1
kind: Deployment
metadata:
name: server
- namespace: maesh-test
+ namespace: test
labels:
app: server
spec:
@@ -74,7 +71,7 @@ spec:
spec:
containers:
- name: server
- image: containous/whoami:v1.4.0
+ image: traefik/whoami:latest
ports:
- containerPort: 80
---
@@ -82,7 +79,7 @@ kind: Service
apiVersion: v1
metadata:
name: server
- namespace: maesh-test
+ namespace: test
spec:
selector:
app: server
@@ -99,7 +96,7 @@ apiVersion: apps/v1
kind: Deployment
metadata:
name: client
- namespace: maesh-test
+ namespace: test
labels:
app: client
spec:
@@ -124,7 +121,7 @@ spec:
Create the namespace then deploy those two applications:
```bash
-kubectl create namespace maesh-test
+kubectl create namespace test
kubectl apply -f server.yaml
kubectl apply -f client.yaml
```
@@ -132,7 +129,7 @@ kubectl apply -f client.yaml
You should now see the following output:
```bash tab="Command"
-kubectl get all -n maesh-test
+kubectl get all -n test
```
```text tab="Expected output"
@@ -156,13 +153,13 @@ replicaset.apps/server-7c8fd58db5 2 2 2 77s
Take note of the client app pod name (here it's `client-7446fdf848-x96fq`) and open a new terminal session inside this pod using `kubectl exec`.
```bash
-kubectl -n maesh-test exec -ti client-7446fdf848-x96fq ash
+kubectl -n test exec -ti client-7446fdf848-x96fq ash
```
From inside the client container, make sure your server is reachable using the Kubernetes DNS service discovery.
```bash tab="Command"
-curl server.maesh-test.svc.cluster.local
+curl server.test.svc.cluster.local
```
```test tab="Expected Output"
@@ -173,17 +170,17 @@ IP: 10.42.2.10
IP: fe80::a4ec:77ff:fe37:1cdd
RemoteAddr: 10.42.2.9:46078
GET / HTTP/1.1
-Host: server.maesh-test.svc.cluster.local
+Host: server.test.svc.cluster.local
User-Agent: curl/7.64.0
Accept: */*
```
You can note that all this server application is doing is to respond with the content of the request it receives.
-Now replace the `svc.cluster.local` suffix by `maesh`, and tada: you are now using Maesh to reach your server!
+Now replace the `svc.cluster.local` suffix by `traefik.mesh`, and tada: you are now using Traefik Mesh to reach your server!
```bash tab="Command"
-curl server.maesh-test.maesh
+curl server.test.traefik.mesh
```
```test tab="Expected Output"
@@ -194,21 +191,21 @@ IP: 10.42.1.7
IP: fe80::601d:7cff:fe26:c8c6
RemoteAddr: 10.42.1.5:59478
GET / HTTP/1.1
-Host: server.maesh-test.maesh
+Host: server.test.traefik.mesh
User-Agent: curl/7.64.0
Accept: */*
Accept-Encoding: gzip
Uber-Trace-Id: 3f9e7129a059f70:7e889a1ebcb147ac:3f9e7129a059f70:1
X-Forwarded-For: 10.42.2.9
-X-Forwarded-Host: server.maesh-test.maesh
+X-Forwarded-Host: server.test.traefik.mesh
X-Forwarded-Port: 80
X-Forwarded-Proto: http
-X-Forwarded-Server: maesh-mesh-w95q2
+X-Forwarded-Server: traefik-mesh-proxy-w95q2
X-Real-Ip: 10.42.2.9
```
-Note the presence of `X-Forwarded` headers as well as other instrumentation headers like `Uber-Trace-Id`, indicating than your request has been processed and instrumented by Maesh.
+Note the presence of `X-Forwarded` headers as well as other instrumentation headers like `Uber-Trace-Id`, indicating than your request has been processed and instrumented by Traefik Mesh.
## What's next
-See the [examples page](examples.md) to see a more advanced example, or dive into the [configuration](configuration.md) to discover all Maesh capabilities.
+See the [examples page](examples.md) to see a more advanced example, or dive into the [configuration](configuration.md) to discover all Traefik Mesh capabilities.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 9087591bf..906260387 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -1,11 +1,11 @@
-site_name: Maesh
-site_description: Maesh Documentation
+site_name: Traefik Mesh
+site_description: Traefik Mesh Documentation
site_author: containo.us
site_url: https://docs.mae.sh
dev_addr: 0.0.0.0:8000
repo_name: 'GitHub'
-repo_url: 'https://github.com/containous/maesh'
+repo_url: 'https://github.com/traefik/mesh'
docs_dir: 'content'
edit_uri: 'edit/master/docs/content/'
@@ -16,8 +16,8 @@ theme:
custom_dir: 'theme'
language: en
include_sidebar: true
- favicon: assets/img/maesh-logo.svg
- logo: assets/img/maesh-logo.svg
+ favicon: assets/img/traefik-mesh-logo.svg
+ logo: assets/img/traefik-mesh-logo.svg
feature:
tabs: false
palette:
@@ -27,7 +27,7 @@ theme:
prev: 'Previous'
next: 'Next'
-copyright: "Copyright © 2016-2020 Containous"
+copyright: "Copyright © 2020 Traefik Labs"
extra_css:
- assets/styles/root.css
@@ -76,7 +76,7 @@ nav:
- 'Examples': 'examples.md'
- 'API': 'api.md'
- 'Migration':
- - 'Maesh v1': 'migration/maesh-v1.md'
+ - 'Traefik Mesh v1': 'migration/traefik-mesh-v1.md'
- 'Helm Chart': 'migration/helm-chart.md'
- 'Contributing':
- 'Thank You!': 'contributing/thank-you.md'
diff --git a/docs/scripts/verify.sh b/docs/scripts/verify.sh
index f451557e1..492b244b7 100755
--- a/docs/scripts/verify.sh
+++ b/docs/scripts/verify.sh
@@ -19,10 +19,10 @@ find "${PATH_TO_SITE}" -type f -not -path "/app/site/theme/*" \
htmlproofer \
--check-html \
--check_external_hash \
- --alt_ignore="/maesh-logo.png/" \
- --alt_ignore="/maesh-logo.svg/" \
+ --alt_ignore="/traefik-mesh-logo.png/" \
+ --alt_ignore="/traefik-mesh-logo.svg/" \
--http_status_ignore="0,500,501,503" \
- --url_ignore="/fonts.gstatic.com/,/docs.mae.sh/,/github.com\/containous\/maesh\/edit*/,/pilot.traefik.io\/profile/,/containo.us/,/docs.traefik.io/,/www.mkdocs.org/,/squidfunk.github.io/,/ietf.org/" \
+ --url_ignore="/fonts.gstatic.com/,/docs.mae.sh/,/github.com\/traefik\/mesh\/edit*/,/pilot.traefik.io\/profile/,/containo.us/,/docs.traefik.io/,/www.mkdocs.org/,/squidfunk.github.io/,/ietf.org/" \
'{}' 1>/dev/null
## HTML-proofer options at https://github.com/gjtorikian/html-proofer#configuration
diff --git a/docs/theme/main.html b/docs/theme/main.html
index c4929f69e..f3b193a66 100644
--- a/docs/theme/main.html
+++ b/docs/theme/main.html
@@ -6,12 +6,12 @@
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
-})(window,document,'script','dataLayer','GTM-W6HPV6C');
+})(window,document,'script','dataLayer','GTM-KVZ2ZDK');
{%- endblock %}
{% block header %}
- {% include "partials/containous-header.html" %}
+ {% include "partials/company-header.html" %}
{% include "partials/header.html" %}
{% endblock %}
diff --git a/docs/theme/partials/containous-header.html b/docs/theme/partials/company-header.html
similarity index 99%
rename from docs/theme/partials/containous-header.html
rename to docs/theme/partials/company-header.html
index e81587e90..44360b7d1 100644
--- a/docs/theme/partials/containous-header.html
+++ b/docs/theme/partials/company-header.html
@@ -197,7 +197,7 @@
-
Interested in joining Containous?
+
Interested in joining Traefik Labs?
-