Update website for stable-2.5.0 release (#470)

- update version in Makefile - add `upgrade` instructions - update CLI reference - community update (draft) Depends on: - #469 - linkerd/linkerd2#3272 Fixes: #464 Signed-off-by: Andrew Seigner <siggy@buoyant.io>
linkerd · Aug 20, 2019 · 620c7b1 · 620c7b1
1 parent 4db49f7
commit 620c7b1
Show file tree

Hide file tree

Showing 6 changed files with 149 additions and 22 deletions.
diff --git a/Makefile b/Makefile
@@ -1,7 +1,7 @@
 
 export PROJECT ?= linkerd-site
 RELEASE_URL = https://github.com/linkerd/linkerd2/releases
-export L5D2_STABLE_VERSION ?= stable-2.4.0
+export L5D2_STABLE_VERSION ?= stable-2.5.0
 export L5D2_EDGE_VERSION ?= edge-19.8.5
 export BUILD_IMAGE ?= gcr.io/linkerd-io/website-builder:1.2.1
 

diff --git a/linkerd.io/content/2/tasks/books.md b/linkerd.io/content/2/tasks/books.md
@@ -180,7 +180,7 @@ Alongside `install` and `inject`, `profile` is also a pure text operation. Check
 out the profile that is generated:
 
 ```yaml
-apiVersion: linkerd.io/v1alpha1
+apiVersion: linkerd.io/v1alpha2
 kind: ServiceProfile
 metadata:
   creationTimestamp: null

diff --git a/linkerd.io/content/2/tasks/upgrade.md b/linkerd.io/content/2/tasks/upgrade.md
@@ -16,6 +16,69 @@ There are three components that need to be upgraded:
 In this guide, we'll walk you through how to upgrade all three components
 incrementally without taking down any of your services.
 
+## Upgrade notice: stable-2.5.0
+
+This release supports Kubernetes 1.12+.
+
+{{< note >}}
+Linkerd 2.5.0 introduced [Helm support](/2/tasks/install-helm/). If Linkerd was
+installed via `linkerd install`, it must be upgraded via `linkerd upgrade`. If
+Linkerd was installed via Helm, it must be upgraded via Helm. Mixing these two
+installation procedures is not supported.
+{{< /note >}}
+
+### Upgrading from stable-2.4.x
+
+{{< note >}}
+These instructions also apply to upgrading from edge-19.7.4, edge-19.7.5,
+edge-19.8.1, edge-19.8.2, edge-19.8.3, edge-19.8.4, and edge-19.8.5.
+{{< /note >}}
+
+Use the `linkerd upgrade` command to upgrade the control plane. This command
+ensures that all of the control plane's existing configuration and mTLS secrets
+are retained.
+
+```bash
+# get the latest stable CLI
+curl -sL https://run.linkerd.io/install | sh
+```
+
+```bash
+linkerd upgrade | kubectl apply -f -
+```
+
+For upgrading a multi-stage installation setup, follow the instructions at
+[Upgrading a multi-stage install](/2/tasks/upgrade/#upgrading-a-multi-stage-install).
+
+Users who have previously saved the Linkerd control plane's configuration to
+files can follow the instructions at
+[Upgrading via manifests](/2/tasks/upgrade/#upgrading-via-manifests)
+to ensure those configuration are retained by the `linkerd upgrade` command.
+
+Once the `upgrade` command completes, use the `linkerd check` command to confirm
+the control plane is ready.
+
+{{< note >}}
+The `stable-2.5` `linkerd check` command will return an error when run against
+an older control plane. This error is benign and will resolve itself once the
+control plane is upgraded to `stable-2.5`:
+
+```bash
+linkerd-config
+--------------
+√ control plane Namespace exists
+√ control plane ClusterRoles exist
+√ control plane ClusterRoleBindings exist
+× control plane ServiceAccounts exist
+    missing ServiceAccounts: linkerd-heartbeat
+    see https://linkerd.io/checks/#l5d-existence-sa for hints
+```
+
+{{< /note >}}
+
+When ready, proceed to upgrading the data plane by following the instructions at
+[Upgrade the data plane](#upgrade-the-data-plane).
+
 ## Upgrade notice: stable-2.4.0
 
 This release supports Kubernetes 1.12+.

diff --git a/linkerd.io/content/blog/service-profiles-for-per-route-metrics.md b/linkerd.io/content/blog/service-profiles-for-per-route-metrics.md
@@ -71,7 +71,7 @@ When paths have parameters in them such as user names or ids, it usually doesn't
 
 ```yml
 ### ServiceProfile for webapp.default ###
-apiVersion: linkerd.io/v1alpha1
+apiVersion: linkerd.io/v1alpha2
 kind: ServiceProfile
 metadata:
   name: webapp.default.svc.cluster.local
@@ -125,7 +125,7 @@ The `linkerd profile --template` command generates a basic service profile spec
 
 ```yml
 ### ServiceProfile for webapp.default ###
-apiVersion: linkerd.io/v1alpha1
+apiVersion: linkerd.io/v1alpha2
 kind: ServiceProfile
 metadata:
   name: webapp.default.svc.cluster.local

diff --git a/linkerd.io/content/dashboard/announcing-linkerd-stable-2-5-0.md b/linkerd.io/content/dashboard/announcing-linkerd-stable-2-5-0.md
@@ -0,0 +1,9 @@
++++
+date = "2019-08-20T04:20:00-07:00"
+title = "Announcing Linkerd 2.5.0 stable"
++++
+
+We are pleased to announce that
+[Linkerd stable-2.5.0](https://github.com/linkerd/linkerd2/releases/tag/stable-2.5.0)
+has been released! This release introduces Helm support, traffic split metrics,
+and RBAC authorization for all tap requests.
diff --git a/linkerd.io/data/cli.yaml b/linkerd.io/data/cli.yaml
@@ -158,17 +158,21 @@
       * pods
       * replicationcontrollers
       * statefulsets
-  Example: "  # Get all edges between pods that either originate from or terminate
-    in the demo namespace.\n  linkerd edges po -n test\n\n  # Get all edges between
-    pods that either originate from or terminate in the default namespace.\n  linkerd
-    edges po\n\t\t\n  # Get all edges between pods in all namespaces.\n  linkerd edges
-    po --all-namespaces"
+  Example: |2-
+      # Get all edges between pods that either originate from or terminate in the demo namespace.
+      linkerd edges po -n test
+
+      # Get all edges between pods that either originate from or terminate in the default namespace.
+      linkerd edges po
+
+      # Get all edges between pods in all namespaces.
+      linkerd edges po --all-namespaces
   InheritedOptions: null
   Name: edges
   Options:
   - DefaultValue: ""
     Name: all-namespaces
-    Shorthand: ""
+    Shorthand: A
     Usage: |
       If present, returns edges across all namespaces, ignoring the "--namespace" flag
   - DefaultValue: ""
@@ -182,7 +186,7 @@
   - DefaultValue: ""
     Name: output
     Shorthand: o
-    Usage: 'Output format; one of: "table" or "json"'
+    Usage: 'Output format; one of: "table" or "json" or "wide"'
   SeeAlso: null
   Synopsis: |
     Display connections between resources, and Linkerd proxy identities
@@ -231,7 +235,7 @@
   Options:
   - DefaultValue: ""
     Name: all-namespaces
-    Shorthand: ""
+    Shorthand: A
     Usage: |
       If present, returns pods across all namespaces, ignoring the "--namespace" flag
   - DefaultValue: ""
@@ -398,6 +402,11 @@
     Shorthand: ""
     Usage: |
       Experimental: Omit the NET_ADMIN capability in the PSP and the proxy-init container when injecting the proxy; requires the linkerd-cni plugin to already be installed
+  - DefaultValue: ""
+    Name: restrict-dashboard-privileges
+    Shorthand: ""
+    Usage: |
+      Restrict the Linkerd Dashboard's default privileges to disallow Tap
   SeeAlso: null
   Synopsis: Output Kubernetes cluster-wide resources to install Linkerd
 - Description: |-
@@ -560,6 +569,11 @@
     Name: registry
     Shorthand: ""
     Usage: Docker registry to pull images from
+  - DefaultValue: ""
+    Name: restrict-dashboard-privileges
+    Shorthand: ""
+    Usage: |
+      Restrict the Linkerd Dashboard's default privileges to disallow Tap
   - DefaultValue: ""
     Name: skip-checks
     Shorthand: ""
@@ -743,6 +757,11 @@
     Name: registry
     Shorthand: ""
     Usage: Docker registry to pull images from
+  - DefaultValue: ""
+    Name: restrict-dashboard-privileges
+    Shorthand: ""
+    Usage: |
+      Restrict the Linkerd Dashboard's default privileges to disallow Tap
   - DefaultValue: ""
     Name: skip-inbound-ports
     Shorthand: ""
@@ -773,24 +792,24 @@
   - DefaultValue: ""
     Name: cni-image
     Shorthand: ""
-    Usage: Image for the cni-plugin.
+    Usage: Image for the cni-plugin
   - DefaultValue: ""
     Name: cni-log-level
     Shorthand: ""
-    Usage: Log level for the cni-plugin.
+    Usage: Log level for the cni-plugin
   - DefaultValue: ""
     Name: control-port
     Shorthand: ""
     Usage: Proxy port to use for control
   - DefaultValue: ""
     Name: dest-cni-bin-dir
     Shorthand: ""
-    Usage: Directory on the host where the CNI plugin binaries reside.
+    Usage: Directory on the host where the CNI plugin binaries reside
   - DefaultValue: ""
     Name: dest-cni-net-dir
     Shorthand: ""
     Usage: |
-      Directory on the host where the CNI configuration will be placed.
+      Directory on the host where the CNI configuration will be placed
   - DefaultValue: ""
     Name: help
     Shorthand: h
@@ -824,6 +843,11 @@
     Name: skip-outbound-ports
     Shorthand: ""
     Usage: Outbound ports that should skip the proxy
+  - DefaultValue: ""
+    Name: use-wait-flag
+    Shorthand: ""
+    Usage: |
+      Configures the CNI plugin to use the "-w" flag for the iptables command. (default false)
   SeeAlso: null
   Synopsis: |
     Output Kubernetes configs to install Linkerd CNI (experimental)
@@ -832,7 +856,7 @@
 
     This command installs Service Profiles into the Linkerd control plane. A
     cluster-wide Linkerd control-plane is a prerequisite. To confirm Service Profile
-    support, verify "kubectl api-versions" outputs "linkerd.io/v1alpha1".
+    support, verify "kubectl api-versions" outputs "linkerd.io/v1alpha2".
   Example: ""
   InheritedOptions: null
   Name: install-sp
@@ -1057,6 +1081,7 @@
       * po mypod1 mypod2
       * rc/my-replication-controller
       * sts/my-statefulset
+      * ts/my-split
       * authority
       * au/my-authority
       * all
@@ -1069,6 +1094,7 @@
       * pods
       * replicationcontrollers
       * statefulsets
+      * trafficsplits
       * authorities (not supported in --from)
       * services (only supported if a --from is also specified, or as a --to)
       * all (all resource types, not supported in --from or --to)
@@ -1088,21 +1114,30 @@
       # Get all inbound stats to the web deployment.
       linkerd stat deploy/web
 
-      # Getl all inbound stats to the pod1 and pod2 pods
+      # Get all inbound stats to the pod1 and pod2 pods
       linkerd stat po pod1 pod2
 
-      # Getl all inbound stats to the pod1 pod and the web deployment
+      # Get all inbound stats to the pod1 pod and the web deployment
       linkerd stat po/pod1 deploy/web
 
-      # Get all pods in all namespaces that call the hello1 deployment in the test namesapce.
+      # Get all pods in all namespaces that call the hello1 deployment in the test namespace.
       linkerd stat pods --to deploy/hello1 --to-namespace test --all-namespaces
 
-      # Get all pods in all namespaces that call the hello1 service in the test namesapce.
+      # Get all pods in all namespaces that call the hello1 service in the test namespace.
       linkerd stat pods --to svc/hello1 --to-namespace test --all-namespaces
 
       # Get all services in all namespaces that receive calls from hello1 deployment in the test namespace.
       linkerd stat services --from deploy/hello1 --from-namespace test --all-namespaces
 
+      # Get all trafficsplits and their leaf services.
+      linkerd stat ts
+
+      # Get the hello-split trafficsplit and its leaf services.
+      linkerd stat ts/hello-split
+
+      # Get all trafficsplits and their leaf services, and metrics for any traffic coming to the leaf services from the hello1 deployment.
+      linkerd stat ts --from deploy/hello1
+
       # Get all namespaces that receive traffic from the default namespace.
       linkerd stat namespaces --from ns/default
 
@@ -1113,7 +1148,7 @@
   Options:
   - DefaultValue: ""
     Name: all-namespaces
-    Shorthand: ""
+    Shorthand: A
     Usage: |
       If present, returns stats across all namespaces, ignoring the "--namespace" flag
   - DefaultValue: ""
@@ -1352,6 +1387,16 @@
     Name: help
     Shorthand: h
     Usage: help for config
+  - DefaultValue: ""
+    Name: linkerd-cni-enabled
+    Shorthand: ""
+    Usage: |
+      Experimental: Omit the NET_ADMIN capability in the PSP and the proxy-init container when injecting the proxy; requires the linkerd-cni plugin to already be installed
+  - DefaultValue: ""
+    Name: restrict-dashboard-privileges
+    Shorthand: ""
+    Usage: |
+      Restrict the Linkerd Dashboard's default privileges to disallow Tap
   SeeAlso: null
   Synopsis: |
     Output Kubernetes cluster-wide resources to upgrade an existing Linkerd
@@ -1494,6 +1539,11 @@
     Name: registry
     Shorthand: ""
     Usage: Docker registry to pull images from
+  - DefaultValue: ""
+    Name: restrict-dashboard-privileges
+    Shorthand: ""
+    Usage: |
+      Restrict the Linkerd Dashboard's default privileges to disallow Tap
   - DefaultValue: ""
     Name: skip-inbound-ports
     Shorthand: ""
@@ -1653,6 +1703,11 @@
     Name: registry
     Shorthand: ""
     Usage: Docker registry to pull images from
+  - DefaultValue: ""
+    Name: restrict-dashboard-privileges
+    Shorthand: ""
+    Usage: |
+      Restrict the Linkerd Dashboard's default privileges to disallow Tap
   - DefaultValue: ""
     Name: skip-inbound-ports
     Shorthand: ""