Update docs for the v2.3.0 release and to use the stable tag

taikit · May 20, 2019 · dc54919 · dc54919
1 parent 4001c96
commit dc54919
Show file tree

Hide file tree

Showing 9 changed files with 39 additions and 59 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,41 +1,17 @@
 # Changelog
 
-
-## 2.3.0-rc3 (2019-05-07)
-
-### Changes since 2.3.0-rc2
-- argo submit --wait and argo wait quits while workflow is running (#1347)
-- Fix validate the secret credentials name and key (#1358)
-- Fix input artifacts with multiple ssh keys (#1338) (@almariah)
-- Add when test for character that included `/` (@hideto0710)
-- Fix parameter substitution bug (#1345) (@elikatsis)
-- Fix missing template local volumes, Handle volumes only used in init containers (#1342)
-
-
-## 2.3.0-rc2 (2019-04-21)
-
-### Changes since 2.3.0-rc1
-+ Support parameter substitution in the volumes attribute (#1238)
-- Fix regression where argoexec wait would not return when podname was too long
-- wait will conditionally become privileged if main/sidecar privileged (issue #1323)
-- `argo list` was not displaying non-zero priorities correctly
-- Pod creation with secret volumemount (#1318)
-- Export the methods of `KubernetesClientInterface` (#1294)
-
-
-## 2.3.0-rc1 (2019-04-10)
+## 2.3.0 (2019-05-20)
 
 ### Notes about upgrading from v2.2
 
-* Secrets are passed to the wait sidecar using volumeMounts instead of performing K8s API calls
- performed by the. This is much more secure since it limits the privileges of the workflow pod
- to no longer require namespace level secret access. However, as a consequence, workflow pods which
- reference a secret that does not exist, will now indefinitely stay in a Pending state, as opposed
- to the previous behavior of failing during runtime.
-
+* Artifact repository secrets are passed to the wait sidecar using volumeMounts instead of the
+ previous behavior of performing K8s API calls performed by the executor. This is much more secure
+ since it removes privileges of the workflow pod to no longer require secret access. However, as a
+ consequence, workflow pods which reference a secret that does not exist, will now indefinitely
+ stay in a Pending state, as opposed to the previous behavior of failing during runtime.
 
 ### Deprecation Notice
-The workflow-controller-configmap introduces a new config field, `executor`, which is a container 
+The workflow-controller-configmap introduces a new config field, `executor`, which is a container
 spec and provides controls over the executor sidecar container (i.e. `init`/`wait`). The fields
 `executorImage`, `executorResources`, and `executorImagePullPolicy` are deprecated and will be
 removed in a future release.
@@ -65,8 +41,9 @@ removed in a future release.
 + Add support for init containers (#1183) (@dtaniwaki)
 + Secrets should be passed to pods using volumes instead of API calls (#1302)
 + Azure AKS authentication issues #1079 (@gerardaus)
++ Support parameter substitution in the volumes attribute (#1238)
 
-### New Features:
+### Refactoring & Improvements:
 * Update dependencies to K8s v1.12 and client-go 9.0
 * Add namespace explicitly to pod metadata (#1059) (@dvavili)
 * Raise not implemented error when artifact saving is unsupported (#1062) (@dtaniwaki)
@@ -77,7 +54,7 @@ removed in a future release.
 * Git cloning via SSH was not verifying host public key (#1261)
 * Speed up podReconciliation using parallel goroutine (#1286) (@xianlubird)
 
-
+### Bug Fixes
 - Initialize child node before marking phase. Fixes panic on invalid `When` (#1075) (@jmcarp)
 - Submodules are dirty after checkout -- need to update (#1052) (@andreimc)
 - Fix output artifact and parameter conflict (#1125) (@Ark-kun)
@@ -100,6 +77,13 @@ removed in a future release.
 - Fix bug with DockerExecutor's CopyFile (#1275)
 - Fix for Resource creation where template has same parameter templating (#1283)
 - Fixes an issue where daemon steps were not getting terminated properly
+- argo submit --wait and argo wait quits while workflow is running (#1347)
+- Fix input artifacts with multiple ssh keys (#1338) (@almariah)
+- Add when test for character that included `/` (@hideto0710)
+- Fix parameter substitution bug (#1345) (@elikatsis)
+- Fix missing template local volumes, Handle volumes only used in init containers (#1342)
+- Export the methods of `KubernetesClientInterface` (#1294)
+
 
 ## 2.2.1 (2018-10-18)
 

diff --git a/README.md b/README.md
@@ -4,6 +4,12 @@
 
 ![Argo Image](argo.png)
 
+## Quickstart
+```bash
+kubectl create namespace argo
+kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo/stable/manifests/install.yaml
+```
+
 ## News
 
 KubeCon 2018 in Seattle was the biggest KubeCon yet with 8000 developers attending. We connected with many existing and new Argoproj users and contributions, and gave away a lot of Argo T-shirts at our booth sponsored by Intuit!

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.3.0-rc3
+2.4.0
diff --git a/demo.md b/demo.md
@@ -11,20 +11,17 @@ the workflows. Here are the requirements and steps to run the workflows.
 
 ## 1. Download Argo
 
-On Mac:
+Download the latest Argo CD version from https://github.com/argoproj/argo/releases/latest.
+
+Also available in Mac Homebrew:
 ```
 brew install argoproj/tap/argo
 ```
-On Linux:
-```
-curl -sSL -o /usr/local/bin/argo https://github.com/argoproj/argo/releases/download/v2.2.1/argo-linux-amd64
-chmod +x /usr/local/bin/argo
-```
 
 ## 2. Install the Controller and UI
 ```
-kubectl create ns argo
-kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo/v2.2.1/manifests/install.yaml
+kubectl create namespace argo
+kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo/stable/manifests/install.yaml
 ```
 NOTE: On GKE, you may need to grant your account the ability to create new clusterroles
 ```

diff --git a/docs/releasing.md b/docs/releasing.md
@@ -50,6 +50,8 @@ In argo repo:
 ```bash
 git push upstream
 git push upstream ${ARGO_RELEASE}
+git tag stable
+git push upstream stable
 ```
 
 In argo-ui repo:

diff --git a/docs/workflow-rbac.md b/docs/workflow-rbac.md
@@ -32,13 +32,4 @@ rules:
  verbs:
  - get
  - watch
-# secrets get is used to retrieve credentials to artifact repository. NOTE: starting n Argo v2.3,
-# the API secret access will be removed in favor of volume mounting the secrets to the workflow pod
-# (issue #1072)
-- apiGroups:
- - ""
- resources:
- - secrets
- verbs:
- - get
 ```
diff --git a/manifests/base/kustomization.yaml b/manifests/base/kustomization.yaml
@@ -9,7 +9,7 @@ bases:
 images:
 - name: argoproj/argoui
  newName: argoproj/argoui
- newTag: v2.3.0-rc3
+ newTag: latest
 - name: argoproj/workflow-controller
  newName: argoproj/workflow-controller
- newTag: v2.3.0-rc3
+ newTag: latest
diff --git a/manifests/install.yaml b/manifests/install.yaml
@@ -228,7 +228,7 @@ spec:
  value: "false"
  - name: BASE_HREF
  value: /
- image: argoproj/argoui:v2.3.0-rc3
+ image: argoproj/argoui:latest
  name: argo-ui
  serviceAccountName: argo-ui
 ---
@@ -250,9 +250,9 @@ spec:
  - --configmap
  - workflow-controller-configmap
  - --executor-image
- - argoproj/argoexec:v2.3.0-rc3
+ - argoproj/argoexec:latest
  command:
  - workflow-controller
- image: argoproj/workflow-controller:v2.3.0-rc3
+ image: argoproj/workflow-controller:latest
  name: workflow-controller
  serviceAccountName: argo
diff --git a/manifests/namespace-install.yaml b/manifests/namespace-install.yaml
@@ -170,7 +170,7 @@ spec:
  value: "false"
  - name: BASE_HREF
  value: /
- image: argoproj/argoui:v2.3.0-rc3
+ image: argoproj/argoui:latest
  name: argo-ui
  serviceAccountName: argo-ui
 ---
@@ -192,9 +192,9 @@ spec:
  - --configmap
  - workflow-controller-configmap
  - --executor-image
- - argoproj/argoexec:v2.3.0-rc3
+ - argoproj/argoexec:latest
  command:
  - workflow-controller
- image: argoproj/workflow-controller:v2.3.0-rc3
+ image: argoproj/workflow-controller:latest
  name: workflow-controller
  serviceAccountName: argo