From 242c4a91f9cead9b55ee621e216be15368e3fe6d Mon Sep 17 00:00:00 2001 From: Tom Clegg Date: Mon, 13 Nov 2023 15:06:21 -0500 Subject: [PATCH] 20690: Remove workbench1 steps from install guide. Arvados-DCO-1.1-Signed-off-by: Tom Clegg --- doc/_config.yml | 1 - ...l-manual-prerequisites.html.textile.liquid | 2 +- .../install-webshell.html.textile.liquid | 2 +- .../install-workbench-app.html.textile.liquid | 106 ------------------ 4 files changed, 2 insertions(+), 109 deletions(-) delete mode 100644 doc/install/install-workbench-app.html.textile.liquid diff --git a/doc/_config.yml b/doc/_config.yml index bddf6d4944..e51b653822 100644 --- a/doc/_config.yml +++ b/doc/_config.yml @@ -235,7 +235,6 @@ navbar: - User interface: - install/setup-login.html.textile.liquid - install/install-ws.html.textile.liquid - - install/install-workbench-app.html.textile.liquid - install/install-workbench2-app.html.textile.liquid - install/workbench.html.textile.liquid # - install/install-composer.html.textile.liquid diff --git a/doc/install/install-manual-prerequisites.html.textile.liquid b/doc/install/install-manual-prerequisites.html.textile.liquid index 67b9f0de33..8819b0210f 100644 --- a/doc/install/install-manual-prerequisites.html.textile.liquid +++ b/doc/install/install-manual-prerequisites.html.textile.liquid @@ -43,7 +43,7 @@ table(table table-bordered table-condensed). |"Keep-web":install-keep-web.html |Gateway service providing read/write HTTP and WebDAV support on top of Keep.|Required to access files from Workbench.| |"Keep-balance":install-keep-balance.html |Storage cluster maintenance daemon responsible for moving blocks to their optimal server location, adjusting block replication levels, and trashing unreferenced blocks.|Required to free deleted data from underlying storage, and to ensure proper replication and block distribution (including support for storage classes).| |\3=. *User interface*| -|"Workbench":install-workbench-app.html, "Workbench2":install-workbench2-app.html |Primary graphical user interface for working with file collections and running containers.|Optional. Depends on API server, keep-web, websockets server.| +|"Workbench2":install-workbench2-app.html |Primary graphical user interface for working with file collections and running containers.|Optional. Depends on API server, keep-web, websockets server.| |\3=. *Additional services*| |"Websockets server":install-ws.html |Event distribution server.|Required to view streaming container logs in Workbench.| |"Shell server":install-shell-server.html |Grant Arvados users access to Unix shell accounts on dedicated shell nodes.|Optional.| diff --git a/doc/install/install-webshell.html.textile.liquid b/doc/install/install-webshell.html.textile.liquid index 8de6fb5959..12b413d5d3 100644 --- a/doc/install/install-webshell.html.textile.liquid +++ b/doc/install/install-webshell.html.textile.liquid @@ -26,7 +26,7 @@ Arvados supports @webshell@, which allows ssh access to shell nodes via the brow h2(#prerequisites). Prerequisites -# "Install workbench":{{site.baseurl}}/install/install-workbench-app.html +# "Install Workbench 2":{{site.baseurl}}/install/install-workbench2-app.html # "Set up a shell node":{{site.baseurl}}/install/install-shell-server.html h2(#configure). Update config.yml diff --git a/doc/install/install-workbench-app.html.textile.liquid b/doc/install/install-workbench-app.html.textile.liquid deleted file mode 100644 index 7ee8db92f1..0000000000 --- a/doc/install/install-workbench-app.html.textile.liquid +++ /dev/null @@ -1,106 +0,0 @@ ---- -layout: default -navsection: installguide -title: Install Workbench -... -{% comment %} -Copyright (C) The Arvados Authors. All rights reserved. - -SPDX-License-Identifier: CC-BY-SA-3.0 -{% endcomment %} - -# "Install dependencies":#dependencies -# "Update config.yml":#update-config -# "Update Nginx configuration":#update-nginx -# "Trusted client flag":#trusted_client -# "Install arvados-workbench":#install-packages -# "Restart the API server and controller":#restart-api -# "Confirm working installation":#confirm-working - -h2(#dependencies). Install dependencies - -# "Install Ruby and Bundler":ruby.html -# "Install nginx":nginx.html -# "Install Phusion Passenger":https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/install_passenger_main.html - -h2(#configure). Update config.yml - -Edit @config.yml@ to set the keys below. The full set of configuration options are in the "Workbench section of config.yml":{{site.baseurl}}/admin/config.html - - -
    Services:
-      Workbench1:
-        ExternalURL: "https://workbench.ClusterID.example.com"
-    Workbench:
-      SecretKeyBase: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
-    Users:
-      AutoAdminFirstUser: true
-
- - -This application needs a secret token. Generate a new secret: - - -
~$ ruby -e 'puts rand(2**400).to_s(36)'
-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
-
- - -Then put that value in the @Workbench.SecretKeyBase@ field. - -You probably want to enable @Users.AutoAdminFirstUser@ . The first user to log in when no other admin user exists will automatically be made an admin. - -h2(#update-nginx). Update nginx configuration - -Use a text editor to create a new file @/etc/nginx/conf.d/arvados-workbench.conf@ with the following configuration. Options that need attention are marked in red. - - -
server {
-    listen       80;
-    server_name  workbench.ClusterID.example.com;
-    return 301   https://workbench.ClusterID.example.com$request_uri;
-}
-
-server {
-  listen       443 ssl;
-  server_name  workbench.ClusterID.example.com;
-
-  ssl_certificate     /YOUR/PATH/TO/cert.pem;
-  ssl_certificate_key /YOUR/PATH/TO/cert.key;
-
-  root /var/www/arvados-workbench/current/public;
-  index  index.html;
-
-  passenger_enabled on;
-  # If you're using RVM, uncomment the line below.
-  #passenger_ruby /usr/local/rvm/wrappers/default/ruby;
-
-  # `client_max_body_size` should match the corresponding setting in
-  # the API.MaxRequestSize and Controller's server's Nginx configuration.
-  client_max_body_size 128m;
-}
-
- - -h2(#trusted_client). Trusted client flag - -In the API server project root, start the Rails console. {% include 'install_rails_command' %} - -Create an ApiClient record for your Workbench installation with the @is_trusted@ flag set. - -
irb(main):001:0> include CurrentApiClient
-=> true
-irb(main):002:0> act_as_system_user do ApiClient.create!(url_prefix: "https://workbench.ClusterID.example.com/", is_trusted: true) end
-=> #<ApiClient id: 2, uuid: "...", owner_uuid: "...", modified_by_client_uuid: nil, modified_by_user_uuid: "...", modified_at: "2019-12-16 14:19:10", name: nil, url_prefix: "https://workbench.ClusterID.example.com/", created_at: "2019-12-16 14:19:10", updated_at: "2019-12-16 14:19:10", is_trusted: true>
-
- - -{% assign arvados_component = 'arvados-workbench' %} - -{% include 'install_packages' %} - -{% include 'restart_api' %} - -h2(#confirm-working). Confirm working installation - -Visit @https://workbench.ClusterID.example.com@ in a browser. You should be able to log in using the login method you configured in the previous step. If @Users.AutoAdminFirstUser@ is true, you will be an admin user. -- 2.30.2