Skip to content

Commit 1dd0110

Browse files
vishesh92Gabriel
authored andcommitted
Change default java version (apache#384)
1 parent cae2ae6 commit 1dd0110

File tree

7 files changed

+323
-11
lines changed

7 files changed

+323
-11
lines changed

source/installguide/hypervisor/kvm.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,8 @@ KVM Instances.
160160
#. Repeat all of these steps on every hypervisor host.
161161

162162
.. warning::
163-
CloudStack |version| requires Java 11 JRE. Installing CloudStack agent will
164-
automatically install Java 11, but it's good to explicitly confirm that the Java 11
163+
CloudStack |version| requires Java 17 JRE. Installing CloudStack agent will
164+
automatically install Java 17, but it's good to explicitly confirm that the Java 17
165165
is the selected/active one (in case you had a previous Java version already installed)
166166
with ``alternatives --config java``, after CloudStack agent is installed.
167167

source/installguide/management-server/_prerequisite.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ node.
103103
will be installed.
104104

105105
.. warning::
106-
CloudStack |version| requires Java 11 JRE. Installing CloudStack packages will
107-
automatically install Java 11, but it's good to explicitly confirm that the Java 11
106+
CloudStack |version| requires Java 17 JRE. Installing CloudStack packages will
107+
automatically install Java 17, but it's good to explicitly confirm that the Java 17
108108
is the selected/active one (in case you had a previous Java version already installed)
109109
with ``alternatives --config java`` after CloudStack packages are already installed.

source/quickinstallationguide/qig.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -459,15 +459,15 @@ following command:
459459
460460
# yum -y install cloudstack-management
461461
462-
CloudStack |version| requires Java 11 JRE. Installing the management server
463-
will automatically install Java 11, but it's good to explicitly confirm that Java 11
462+
CloudStack |version| requires Java 17 JRE. Installing the management server
463+
will automatically install Java 17, but it's good to explicitly confirm that Java 17
464464
is the selected/active one (in case you had a previous Java version already installed):
465465

466466
.. parsed-literal::
467467
468468
$ alternatives --config java
469469
470-
Make sure that Java 11 is selected.
470+
Make sure that Java 17 is selected.
471471

472472
With the application itself installed we can now setup the database, we'll do
473473
that with the following command and options:

source/releasenotes/compat.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ CloudStack Management Server.
3636
Software Requirements
3737
~~~~~~~~~~~~~~~~~~~~~
3838

39-
- Java JRE 11
39+
- Java JRE 17
4040
- MySQL 5.6, 5.7, 8.0
4141

4242
Supported Hypervisor Versions

source/upgrading/upgrade/_java_version.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@
1818
Java Version Requirement
1919
------------------------
2020

21-
CloudStack |version| requires installation of Java 11 JRE for management server
21+
CloudStack |version| requires installation of Java 17 JRE for management server
2222
and the KVM agent. On installing or upgrading cloudstack-management and/or
23-
cloudstack-agent packages, please configure Java 11 as the default java
23+
cloudstack-agent packages, please configure Java 17 as the default java
2424
version using:
2525

2626
.. parsed-literal::
2727
2828
$ sudo alternatives --config java
2929
30-
Note: For Ubuntu distributions where the openjdk-11 packages are not available
30+
Note: For Ubuntu distributions where the openjdk-17 packages are not available
3131
from the main repositories, the JRE can be installed from an external PPA such
3232
as openjdk-r. The PPA can be added before installation/upgrade:
3333

Lines changed: 303 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,303 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
or more contributor license agreements. See the NOTICE file
3+
distributed with this work for additional information#
4+
regarding copyright ownership. The ASF licenses this file
5+
to you under the Apache License, Version 2.0 (the
6+
"License"); you may not use this file except in compliance
7+
with the License. You may obtain a copy of the License at
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
Unless required by applicable law or agreed to in writing,
10+
software distributed under the License is distributed on an
11+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
12+
KIND, either express or implied. See the License for the
13+
specific language governing permissions and limitations
14+
under the License.
15+
16+
.. |version_to_upgrade| replace:: 4.18.x
17+
18+
Upgrade Instruction from |version_to_upgrade|
19+
=============================================
20+
21+
22+
This section will show you how to upgrade from CloudStack |version_to_upgrade| to latest
23+
CloudStack |release|.
24+
25+
Any steps that are hypervisor-specific will be called out with a note.
26+
27+
We recommend reading through this section once or twice before beginning
28+
your upgrade procedure, and working through it on a test system before
29+
working on a production system.
30+
31+
.. note::
32+
The following upgrade instructions should be performed regardless of
33+
hypervisor type.
34+
35+
Overview of Upgrade Steps:
36+
----------------------------
37+
38+
#. Check any customisations and integrations
39+
#. Upload the |sysvm64-version| System VM template if not already using it.
40+
#. Confirm Java 17 is the default Java version
41+
#. Stop all running management servers
42+
#. Backup CloudStack database (MySQL)
43+
#. Upgrade 1st CloudStack management server
44+
#. Update hypervisors specific dependencies
45+
#. Restart 1st management server
46+
#. Check that your upgraded environment works as expected
47+
#. Upgrade and restart the remaining management servers
48+
49+
50+
.. include:: _customisation_warnings.rst
51+
52+
.. include:: _sysvm_templates.rst
53+
54+
.. include:: _java_version.rst
55+
56+
Packages repository
57+
-------------------
58+
59+
Most users of CloudStack manage the installation and upgrades of
60+
CloudStack with one of Linux's predominant package systems, RPM or
61+
APT. This guide assumes you'll be using RPM and Yum (for Red Hat
62+
Enterprise Linux or CentOS), or APT and Debian packages (for Ubuntu).
63+
64+
Create RPM or Debian packages (as appropriate) and a repository from
65+
the |release| source, or check the Apache CloudStack downloads page at
66+
http://cloudstack.apache.org/downloads.html
67+
for package repositories supplied by community members. You will need
68+
them for :ref:`ubuntu414` or :ref:`kvm414` hosts upgrade.
69+
70+
Instructions for creating packages from the CloudStack source are in the
71+
`CloudStack Installation Guide`_.
72+
73+
Database Preparation
74+
--------------------
75+
76+
Backup current database
77+
78+
#. Stop your management server or servers. Run this on all management
79+
server hosts:
80+
81+
.. parsed-literal::
82+
83+
$ sudo service cloudstack-management stop
84+
85+
#. If you are running a usage server or usage servers, stop those as well:
86+
87+
.. parsed-literal::
88+
89+
$ sudo service cloudstack-usage stop
90+
91+
#. Make a backup of your MySQL database. If you run into any issues or
92+
need to roll back the upgrade, this will assist in debugging or
93+
restoring your existing environment. You'll be prompted for your
94+
password.
95+
96+
.. parsed-literal::
97+
98+
$ mysqldump -u root -p -R cloud > cloud-backup_$(date +%Y-%m-%d-%H%M%S)
99+
$ mysqldump -u root -p cloud_usage > cloud_usage-backup_$(date +%Y-%m-%d-%H%M%S)
100+
101+
102+
.. _ubuntu414:
103+
.. _apt-repo414:
104+
105+
Management Server
106+
-----------------
107+
108+
Ubuntu
109+
######
110+
111+
If you are using Ubuntu, follow this procedure to upgrade your packages. If
112+
not, skip to step :ref:`rhel414`.
113+
114+
.. note::
115+
**Community Packages:** This section assumes you're using the community
116+
supplied packages for CloudStack. If you've created your own packages and
117+
APT repository, substitute your own URL for the ones used in these examples.
118+
119+
The first order of business will be to change the sources list for
120+
each system with CloudStack packages. This means all management
121+
servers, and any hosts that have the KVM agent (no changes should
122+
be necessary for hosts that are running VMware or Xen.)
123+
124+
Edit your ``/etc/apt/sources.list.d/cloudstack.list`` file on
125+
any systems that have CloudStack packages installed to points to version |version|
126+
127+
This file should have one line, which contains:
128+
129+
.. parsed-literal::
130+
131+
deb http://download.cloudstack.org/ubuntu bionic |version|
132+
133+
Setup the public key for the above repository:
134+
135+
.. parsed-literal::
136+
137+
wget -qO - http://download.cloudstack.org/release.asc | sudo apt-key add -
138+
139+
#. Now update your apt package list:
140+
141+
.. parsed-literal::
142+
143+
$ sudo apt-get update
144+
145+
#. Now that you have the repository configured, it's time to upgrade
146+
the ``cloudstack-management`` package.
147+
148+
.. parsed-literal::
149+
150+
$ sudo apt-get upgrade cloudstack-management
151+
152+
#. If you use CloudStack usage server
153+
154+
.. parsed-literal::
155+
156+
$ sudo apt-get upgrade cloudstack-usage
157+
158+
159+
.. _rhel414:
160+
.. _rpm-repo414:
161+
162+
CentOS/RHEL
163+
##############
164+
165+
If you are using CentOS or RHEL, follow this procedure to upgrade your
166+
packages. If not, skip to hypervisors section :ref:`upg_hyp_414`.
167+
168+
.. note::
169+
**Community Packages:** This section assumes you're using the community
170+
supplied packages for CloudStack. If you've created your own packages and
171+
yum repository, substitute your own URL for the ones used in these examples.
172+
173+
The first order of business will be to change the yum repository
174+
for each system with CloudStack packages. This means all
175+
management servers, and any hosts that have the KVM agent (no changes
176+
should be necessary for hosts that are running VMware or Xen.)
177+
178+
Change your ``/etc/yum.repos.d/cloudstack.repo`` file on
179+
any systems that have CloudStack packages installed to points to version |version|.
180+
181+
This file should have content similar to the following:
182+
183+
.. parsed-literal::
184+
185+
[apache-cloudstack]
186+
name=Apache CloudStack
187+
baseurl=http://download.cloudstack.org/centos/$releasever/|version|/
188+
enabled=1
189+
gpgcheck=0
190+
191+
Setup the GPG public key if you wish to enable ``gpgcheck=1``:
192+
193+
.. parsed-literal::
194+
195+
rpm --import http://download.cloudstack.org/RPM-GPG-KEY
196+
197+
#. Now that you have the repository configured, it's time to upgrade the
198+
``cloudstack-management``.
199+
200+
.. parsed-literal::
201+
202+
$ sudo yum upgrade cloudstack-management
203+
204+
#. If you use CloudStack usage server
205+
206+
.. parsed-literal::
207+
208+
$ sudo yum upgrade cloudstack-usage
209+
210+
.. _upg_hyp_414:
211+
212+
Upgrade Hypervisors
213+
-------------------
214+
215+
Hypervisor: XenServer
216+
#####################
217+
218+
219+
No additional steps are required for XenServer Hypervisor for this upgrade.
220+
221+
222+
Hypervisor: VMware
223+
###################
224+
225+
.. warning::
226+
For VMware hypervisor, CloudStack management server packages must be
227+
built using "noredist". Refer to :ref:`building-noredist`.
228+
229+
230+
No additional steps are requried for the VMware Hypervisor for this upgrade.
231+
232+
233+
.. _kvm414:
234+
235+
Hypervisor: KVM
236+
#################
237+
238+
KVM on Ubuntu
239+
""""""""""""""
240+
241+
(KVM only) Additional steps are required for each KVM host. These
242+
steps will not affect running guests in the cloud. These steps are
243+
required only for clouds using KVM as hosts and only on the KVM
244+
hosts.
245+
246+
#. Configure the :ref:`APT repo <apt-repo414>` as detailed above.
247+
248+
#. Stop the running agent.
249+
250+
.. parsed-literal::
251+
252+
$ sudo service cloudstack-agent stop
253+
254+
#. Update the agent software.
255+
256+
.. parsed-literal::
257+
258+
$ sudo apt-get upgrade cloudstack-agent
259+
260+
#. Start the agent.
261+
262+
.. parsed-literal::
263+
264+
$ sudo service cloudstack-agent start
265+
266+
267+
KVM on CentOS/RHEL
268+
"""""""""""""""""""
269+
270+
For KVM hosts, upgrade the ``cloudstack-agent`` package
271+
272+
#. Configure the :ref:`rpm-repo414` as detailed above.
273+
274+
.. parsed-literal::
275+
276+
$ sudo yum install -y epel-release
277+
$ sudo yum upgrade cloudstack-agent
278+
279+
#. Restart the agent:
280+
281+
.. parsed-literal::
282+
283+
$ sudo service cloudstack-agent stop
284+
$ sudo service cloudstack-agent start
285+
286+
287+
Restart management services
288+
---------------------------
289+
290+
#. Now it's time to start the management server
291+
292+
.. parsed-literal::
293+
294+
$ sudo service cloudstack-management start
295+
296+
#. If you use it, start the usage server
297+
298+
.. parsed-literal::
299+
300+
$ sudo service cloudstack-usage start
301+
302+
303+
.. include:: _sysvm_restart.rst

source/upgrading/upgrade/upgrade_notes.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,15 @@
1717
General Upgrade Notes
1818
=====================
1919

20+
Java version upgraded to Java 17
21+
---------------------------------
22+
23+
As of Apache CloudStack 4.20, support for running with Java 17 has been added.
24+
In later versions, support for Java 11 will be removed.
25+
26+
27+
.. include:: _java_version.rst
28+
2029

2130
Java version upgraded to Java 11
2231
---------------------------------

0 commit comments

Comments
 (0)