Put back TrueTool content
This commit is contained in:
Kjeld Schouten-Lebbing
parent
f25c44123d
commit
ac1cdb755c
25
.github/renovate-config.js
vendored
Normal file
25
.github/renovate-config.js
vendored
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
module.exports = {
|
||||||
|
dryRun: false,
|
||||||
|
username: 'truecharts-admin',
|
||||||
|
gitAuthor: 'truecharts-admin <bot@truecharts.org>',
|
||||||
|
onboarding: false,
|
||||||
|
platform: 'github',
|
||||||
|
repositories: [
|
||||||
|
'truecharts/truetool',
|
||||||
|
],
|
||||||
|
packageRules: [
|
||||||
|
{
|
||||||
|
description: 'lockFileMaintenance',
|
||||||
|
matchUpdateTypes: [
|
||||||
|
'pin',
|
||||||
|
'digest',
|
||||||
|
'patch',
|
||||||
|
'minor',
|
||||||
|
'major',
|
||||||
|
'lockFileMaintenance',
|
||||||
|
],
|
||||||
|
dependencyDashboardApproval: false,
|
||||||
|
stabilityDays: 0,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
23
.github/renovate.json5
vendored
Normal file
23
.github/renovate.json5
vendored
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
{
|
||||||
|
"semanticCommits": "enabled",
|
||||||
|
"extends": ["helpers:pinGitHubActionDigests"],
|
||||||
|
"dependencyDashboard": true,
|
||||||
|
"dependencyDashboardTitle": "Renovate Dashboard 🤖",
|
||||||
|
"suppressNotifications": ["prIgnoreNotification"],
|
||||||
|
"commitMessageTopic": "{{depName}}",
|
||||||
|
"commitMessageExtra": "to {{newVersion}}",
|
||||||
|
"commitMessageSuffix": "",
|
||||||
|
"rebaseWhen": "conflicted",
|
||||||
|
"prConcurrentLimit": 100,
|
||||||
|
"pinDigests": true,
|
||||||
|
"automerge": true,
|
||||||
|
"gitAuthor": "TrueCharts-Admin <bot@truecharts.org>",
|
||||||
|
"packageRules": [
|
||||||
|
// Setup datasources for github actions
|
||||||
|
{
|
||||||
|
"matchManagers": ["github-actions"],
|
||||||
|
"commitMessageTopic": "github-action {{depName}} [skip ci]",
|
||||||
|
"automerge": true,
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
18
.github/workflows/renovate.yml
vendored
Normal file
18
.github/workflows/renovate.yml
vendored
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
name: Renovate
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
schedule:
|
||||||
|
- cron: "0 */6 * * *"
|
||||||
|
jobs:
|
||||||
|
renovate:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b # v3.2.0
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.BOT_TOKEN }}
|
||||||
|
- name: Self-hosted Renovate
|
||||||
|
uses: renovatebot/github-action@d4496c2d9b06c4e43b227fc3f331a434e99eaef5 # v34.73.3
|
||||||
|
with:
|
||||||
|
configurationFile: .github/renovate-config.js
|
||||||
|
token: ${{ secrets.BOT_TOKEN }}
|
||||||
27
.github/workflows/shellcheck.yml
vendored
27
.github/workflows/shellcheck.yml
vendored
@ -3,19 +3,24 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
name: ShellCheck
|
name: 'Lint and Test'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
ShellCheck:
|
shellcheck:
|
||||||
name: ShellCheck
|
name: Shellcheck
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b # v3
|
||||||
- name: Run ShellCheck
|
- name: Run ShellCheck
|
||||||
uses: ludeeus/action-shellcheck@master
|
uses: ludeeus/action-shellcheck@master
|
||||||
env:
|
with:
|
||||||
SHELLCHECK_OPTS: -e SC2154
|
check_together: 'yes'
|
||||||
with:
|
env:
|
||||||
check_together: 'yes'
|
SHELLCHECK_OPTS: -e SC2154
|
||||||
format: gcc
|
|
||||||
|
|
||||||
|
pre-commit:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b # v3
|
||||||
|
- uses: actions/setup-python@5ccb29d8773c3f3f653e1705f474dfaa8a06a912 # v4
|
||||||
|
- uses: pre-commit/action@646c83fcd040023954eafda54b4db0192ce70507 # tag=v3.0.0
|
||||||
|
|||||||
21
.pre-commit-config.yaml
Normal file
21
.pre-commit-config.yaml
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
# See https://pre-commit.com for more information
|
||||||
|
repos:
|
||||||
|
- repo: https://github.com/Lucas-C/pre-commit-hooks
|
||||||
|
rev: v1.1.10
|
||||||
|
hooks:
|
||||||
|
- id: remove-tabs
|
||||||
|
|
||||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
|
rev: v4.0.1
|
||||||
|
hooks:
|
||||||
|
- id: trailing-whitespace
|
||||||
|
- id: end-of-file-fixer
|
||||||
|
- id: fix-byte-order-marker
|
||||||
|
- id: mixed-line-ending
|
||||||
|
- id: check-merge-conflict
|
||||||
|
- id: check-case-conflict
|
||||||
|
- id: check-executables-have-shebangs
|
||||||
|
- id: check-docstring-first
|
||||||
|
- id: check-symlinks
|
||||||
|
- id: destroyed-symlinks
|
||||||
|
- id: fix-byte-order-marker
|
||||||
703
LICENSE
703
LICENSE
@ -1,674 +1,29 @@
|
|||||||
GNU GENERAL PUBLIC LICENSE
|
BSD 3-Clause License
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
Copyright (c) 2022, TrueCharts
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
All rights reserved.
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are met:
|
||||||
Preamble
|
|
||||||
|
1. Redistributions of source code must retain the above copyright notice, this
|
||||||
The GNU General Public License is a free, copyleft license for
|
list of conditions and the following disclaimer.
|
||||||
software and other kinds of works.
|
|
||||||
|
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||||
The licenses for most software and other practical works are designed
|
this list of conditions and the following disclaimer in the documentation
|
||||||
to take away your freedom to share and change the works. By contrast,
|
and/or other materials provided with the distribution.
|
||||||
the GNU General Public License is intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
3. Neither the name of the copyright holder nor the names of its
|
||||||
software for all its users. We, the Free Software Foundation, use the
|
contributors may be used to endorse or promote products derived from
|
||||||
GNU General Public License for most of our software; it applies also to
|
this software without specific prior written permission.
|
||||||
any other work released this way by its authors. You can apply it to
|
|
||||||
your programs, too.
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||||
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
When we speak of free software, we are referring to freedom, not
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||||
have the freedom to distribute copies of free software (and charge for
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
them if you wish), that you receive source code or can get it if you
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||||
want it, that you can change the software or use pieces of it in new
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||||
free programs, and that you know you can do these things.
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||||
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
To protect your rights, we need to prevent others from denying you
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
these rights or asking you to surrender the rights. Therefore, you have
|
|
||||||
certain responsibilities if you distribute copies of the software, or if
|
|
||||||
you modify it: responsibilities to respect the freedom of others.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must pass on to the recipients the same
|
|
||||||
freedoms that you received. You must make sure that they, too, receive
|
|
||||||
or can get the source code. And you must show them these terms so they
|
|
||||||
know their rights.
|
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps:
|
|
||||||
(1) assert copyright on the software, and (2) offer you this License
|
|
||||||
giving you legal permission to copy, distribute and/or modify it.
|
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains
|
|
||||||
that there is no warranty for this free software. For both users' and
|
|
||||||
authors' sake, the GPL requires that modified versions be marked as
|
|
||||||
changed, so that their problems will not be attributed erroneously to
|
|
||||||
authors of previous versions.
|
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run
|
|
||||||
modified versions of the software inside them, although the manufacturer
|
|
||||||
can do so. This is fundamentally incompatible with the aim of
|
|
||||||
protecting users' freedom to change the software. The systematic
|
|
||||||
pattern of such abuse occurs in the area of products for individuals to
|
|
||||||
use, which is precisely where it is most unacceptable. Therefore, we
|
|
||||||
have designed this version of the GPL to prohibit the practice for those
|
|
||||||
products. If such problems arise substantially in other domains, we
|
|
||||||
stand ready to extend this provision to those domains in future versions
|
|
||||||
of the GPL, as needed to protect the freedom of users.
|
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents.
|
|
||||||
States should not allow patents to restrict development and use of
|
|
||||||
software on general-purpose computers, but in those that do, we wish to
|
|
||||||
avoid the special danger that patents applied to a free program could
|
|
||||||
make it effectively proprietary. To prevent this, the GPL assures that
|
|
||||||
patents cannot be used to render the program non-free.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU Affero General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the special requirements of the GNU Affero General Public License,
|
|
||||||
section 13, concerning interaction through a network will apply to the
|
|
||||||
combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU General Public License from time to time. Such new versions will
|
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
|
||||||
notice like this when it starts in an interactive mode:
|
|
||||||
|
|
||||||
<program> Copyright (C) <year> <name of author>
|
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, your program's commands
|
|
||||||
might be different; for a GUI interface, you would use an "about box".
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU GPL, see
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
|
||||||
into proprietary programs. If your program is a subroutine library, you
|
|
||||||
may consider it more useful to permit linking proprietary applications with
|
|
||||||
the library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License. But first, please read
|
|
||||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
||||||
|
|||||||
225
README.md
225
README.md
@ -1,12 +1,13 @@
|
|||||||
# heavy_script
|
# truetool
|
||||||
|
|
||||||
## Website
|
An easy tool for frequently used TrueNAS SCALE CLI utilities.
|
||||||
|
|
||||||
[HeavySetup - Further Explanation](https://heavysetup.info/scripts/heavyscript/about/)
|
Please before using this tool, [read this note](https://truecharts.org/manual/guides/Important-MUST-READ)
|
||||||
|
|
||||||
## Table of contents:
|
## Table of contents:
|
||||||
* [Update Arguments](#update-arguments)
|
|
||||||
* [Other Utilities](#other-utilities)
|
* [Synopsis](#synopsis)
|
||||||
|
* [Arguments](#arguments)
|
||||||
* [How to Install](#how-to-install)
|
* [How to Install](#how-to-install)
|
||||||
* [How to Update](#how-to-update)
|
* [How to Update](#how-to-update)
|
||||||
* [Creating a Cron Job](#creating-a-cron-job)
|
* [Creating a Cron Job](#creating-a-cron-job)
|
||||||
@ -14,171 +15,83 @@
|
|||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
## The Menu
|
## Synopsis
|
||||||
|
|
||||||
|
TrueTool is a command line tool, designed to enable some features of TrueNAS SCALE that are either not-enabled by default or not-available in the Web-GUI.
|
||||||
> Access this with `bash heavy_script.sh`
|
It also offers a few handy shortcuts for commonly required chores, like: Enabling Apt or Helm
|
||||||
|
|
||||||
<br >
|
## Arguments
|
||||||
<br >
|
|
||||||
|
|
||||||
## Update Arguments
|
| Flag | Example | Parameter | Description |
|
||||||
| Flag | Example | Parameter | Description |
|
| --------------- | ---------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|---------------|------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| --delete-backup | --delete-backup | None | Opens a menu to delete backups<br>_Useful if you need to delete old system backups or backups from other scripts_ |
|
||||||
| -U | -U <br>-U 5 | Optional Integer | Update applications, ignoring major version changes<br>_Optionally, you can supply a number after the argument to update multiple applications at once_ |
|
| --restore | --restore | None | Restore TrueTool specific `ix-applications dataset` snapshot |
|
||||||
| -u | -u<br>-u 5 | Optional Integer | Update applications, do NOT update if there was a major version change<br>_Optionally, you can supply a number after the argument to update multiple applications at once_ |
|
| --mount | --mount | None | Initiates mounting feature<br>Choose between unmounting and mounting PVC data |
|
||||||
| -b | -b 14 | Integer | Snapshot ix-applications dataset<br>_Creates backups UP TO the number you've chosen_ |
|
| --dns | --dns | None | list all of your applications DNS names and their web ports |
|
||||||
| -i | -i nextcloud -i sonarr | String | Applications listed will be ignored during updating<br>_List one application after another as shown in the example_ |
|
| --list-backups | --list-backups | None | Prints a list of backups available |
|
||||||
| -r | -r | | Monitors applications after they update<br>If the app does not become "ACTIVE" after the timeout, rollback the application. |
|
| --helm-enable | --helm-enable | None | Enables Helm command access on SCALE |
|
||||||
| -v | -v | | Verbose Output<br>_Look at the bottom of this page for an example_ |
|
| --kubeapi-enable | --kubeapi-enable | None | Enables external access to Kuberntes API port |
|
||||||
| -S | -S | | Shutdown the application prior to updating it |
|
| --apt-enable | --apt-enable | None | Enables Apt command access on SCALE |
|
||||||
| -t | -t 400 | Integer | Time in seconds that HeavyScript will wait for an application to no longer be deploying before declaring failure<br>Default: 500 |
|
| --no-color | --no-color | None | Disables showing colors in terminal output, usefull for SCALE Email output |
|
||||||
| -s | -s | | Sync Catalogs prior to updating |
|
| -U | -U | None | Update applications, ignoring major version changes |
|
||||||
| -p | -p | | Prune unused docker images |
|
| -u | -u | None | Update applications, do NOT update if there was a major version change |
|
||||||
| --ignore-img | --ignore-img | | Ignore container image updates |
|
| -b | -b 14 | Integer | Backup `ix-applications` dataset<br>_Creates backups up to the number you've chosen_ |
|
||||||
| --self-update | --self-update | | Updates HeavyScript prior to running any other commands |
|
| -i | -i nextcloud -i sonarr | String | Applications listed will be ignored during updating<br>_List one application after another as shown in the example_ |
|
||||||
|
| -v | -v | None | Verbose Output<br> |
|
||||||
|
| -t | -t 150 | Integer | Set a custom timeout to be used with either:<br>`-m` <br>_Time the script will wait for application to be "STOPPED"_<br>or<br>`-(u\|U)` <br>_Time the script will wait for application to be either "STOPPED" or "ACTIVE"_ |
|
||||||
|
| -s | -s | None | Sync Catalogs prior to updating |
|
||||||
|
| -p | -p | None | Prune old/unused docker images |
|
||||||
|
|
||||||
|
|
||||||
### Example
|
|
||||||
#### Cron Job
|
|
||||||
```
|
|
||||||
bash heavy_script.sh --self-update -b 10 -i nextcloud -i sonarr -t 600 --ignore-img -rsp -u 5
|
|
||||||
```
|
|
||||||
|
|
||||||
> `-b` is set to 10. Up to 10 snapshots of your ix-applications dataset will be saved
|
|
||||||
|
|
||||||
> `-i` is set to ignore __nextcloud__ and __sonarr__. These applications will be skipped if they have an update.
|
|
||||||
|
|
||||||
> `-t` I set it to 600 seconds, this means the script will wait 600 seconds for the application to become ACTIVE before timing out and rolling back to the previous version since `-r` is used.
|
|
||||||
|
|
||||||
> `--ignore-img` Will not update the application if it is only a container image update
|
|
||||||
|
|
||||||
> `-r` Will rollback applications if they fail to deploy within the timeout, after updating.
|
|
||||||
|
|
||||||
> `-s` will just sync the repositories, ensuring you are downloading the latest updates.
|
|
||||||
|
|
||||||
> `-p` Prune docker images.
|
|
||||||
|
|
||||||
> `-u` update applications as long as the major version has absolutely no change, if it does have a change it will ask the user to update manually.
|
|
||||||
>> The `5` after the `-u` means up to 5 applications will be updating and monitored at one time
|
|
||||||
|
|
||||||
> `--self-update` Will update the script prior to running anything else.
|
|
||||||
|
|
||||||
<br >
|
|
||||||
|
|
||||||
#### My Personal Cron Job
|
|
||||||
```
|
|
||||||
bash /mnt/speed/scripts/heavy_script/heavy_script.sh --self-update -b 10 -rsp -u 10
|
|
||||||
```
|
|
||||||
|
|
||||||
<br >
|
|
||||||
<br>
|
|
||||||
|
|
||||||
## Other Utilities
|
|
||||||
> All of these can ALSO be accessed with the HeavyScript menu, that you can access simply by not providing an argument `bash heavy_script.sh`
|
|
||||||
|
|
||||||
| Flag | Description |
|
|
||||||
|-----------------|----------------------------------------------------------------------------------------------|
|
|
||||||
| --mount | Initiates mounting feature, choose between unmounting and mounting PVC data |
|
|
||||||
| --restore | Opens a menu to restore a heavy_script backup that was taken on your ix-applications dataset |
|
|
||||||
| --delete-backup | Opens a menu to delete backups on your system |
|
|
||||||
| --dns | list all of your applications DNS names and their web ports |
|
|
||||||
| --cmd | Open a shell for one of your applications |
|
|
||||||
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
#### Mounting PVC Data
|
|
||||||
|
|
||||||
```
|
|
||||||
bash /mnt/tank/scripts/heavy_script.sh --mount
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Restoring ix-applications dataset
|
|
||||||
|
|
||||||
```
|
|
||||||
bash /mnt/tank/scripts/heavy_script/heavy_script.sh --restore
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Deleting Backups
|
|
||||||
|
|
||||||
```
|
|
||||||
bash /mnt/tank/scripts/heavy_script/heavy_script.sh --delete-backup
|
|
||||||
```
|
|
||||||
|
|
||||||
#### List All DNS Names
|
|
||||||
|
|
||||||
```
|
|
||||||
bash /mnt/tank/scripts/heavy_script/heavy_script.sh --dns
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Open a Containers Shell
|
|
||||||
|
|
||||||
```
|
|
||||||
bash /mnt/speed/scripts/heavy_script/heavy_script.sh --cmd
|
|
||||||
```
|
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
|
||||||
## How to Install
|
## How to Install
|
||||||
|
|
||||||
### Create a Scripts Dataset
|
### Choose a folder
|
||||||
|
|
||||||
I created a `scripts` dataset on my Truenas SCALE system, this is where all my scripts will remain.
|
It's important to save the script in a folder that is persistent across TrueNAS System Updates.
|
||||||
|
This saves you from reinstalling or experiencing an accidental lack-of-backups after an update.
|
||||||
|
|
||||||
|
##### New dataset
|
||||||
|
|
||||||
|
In this example we created a `scripts` dataset on the TrueNAS SCALE system, feel free to use another folder.
|
||||||
|
|
||||||
|
##### Root folder
|
||||||
|
|
||||||
|
The `/root` folder houses files for the root user.
|
||||||
|
It's also persistent across updates and hence can be safely used for storing the script.
|
||||||
|
|
||||||
### Open a Terminal
|
### Open a Terminal
|
||||||
|
|
||||||
**Change Directory to your scripts folder**
|
**Change Directory to your scripts folder**
|
||||||
|
|
||||||
```
|
```
|
||||||
cd /mnt/speed/scripts
|
cd /mnt/pool/scripts
|
||||||
```
|
```
|
||||||
|
|
||||||
**Git Clone Heavy_Script**
|
**Git Clone truetool**
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/Heavybullets8/heavy_script.git
|
git clone https://github.com/truecharts/truetool.git
|
||||||
```
|
```
|
||||||
|
|
||||||
**Change Directory to Heavy_Script folder**
|
**Change Directory to truetool folder**
|
||||||
|
|
||||||
```
|
```
|
||||||
cd heavy_script
|
cd truetool
|
||||||
```
|
```
|
||||||
|
|
||||||
From here, you can just run Heavy_Script with `bash heavy_script.sh -ARGUMENTS`
|
From here, you can just run truetool with `bash truetool.sh -ARGUMENTS`
|
||||||
|
|
||||||
> Note: `chmod +x` is NOT required. Doing this will break the `git pull` (or self update) function. Just run the script with `bash heavy_script.sh`
|
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
## How to Update
|
## How to Update
|
||||||
|
|
||||||
### Built-In Option (Recommended)
|
TrueTool updates itself automatically.
|
||||||
|
|
||||||
```
|
|
||||||
bash heavyscript.sh --self-update -b 10 -supr
|
|
||||||
```
|
|
||||||
> The important argument here is the `--self-update`, you can still use all of your same arguments with this option.
|
|
||||||
>> `--self-update` will place users on the latest tag, as well as showing the changelog when new releases come out. So this is the preferred method. Not using this method, will instead place the user on `main`, where the changes are tested, but not as rigerously as they are on the releases.
|
|
||||||
|
|
||||||
<br >
|
<br >
|
||||||
|
|
||||||
### Manually
|
|
||||||
|
|
||||||
#### Open a Terminal
|
|
||||||
|
|
||||||
**Change Directory to your heavy_script folder**
|
|
||||||
```
|
|
||||||
cd /mnt/speed/scripts/heavy_script
|
|
||||||
```
|
|
||||||
|
|
||||||
**git pull**
|
|
||||||
```
|
|
||||||
git pull
|
|
||||||
```
|
|
||||||
> This is not recommended because the changes to main are not tested as much as the changes that are pushed to releases are tested, think of this method of updating as being in development.
|
|
||||||
|
|
||||||
<br >
|
|
||||||
<br >
|
|
||||||
|
|
||||||
## Creating a Cron Job
|
## Creating a Cron Job
|
||||||
|
|
||||||
@ -188,29 +101,31 @@ git pull
|
|||||||
4. Cron Jobs
|
4. Cron Jobs
|
||||||
1. Click Add
|
1. Click Add
|
||||||
|
|
||||||
| Name | Value | Reason |
|
| Name | Value | Reason |
|
||||||
|------------------------ |------------------------------------------------------------------------------------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
| ---------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `Description` | HeavyScript git pull and Update apps | This is up to you, put whatever you think is a good description in here |
|
| `Description` | TrueTool Update apps | This is up to you, put whatever you think is a good description in here |
|
||||||
| `Command` | `bash /PATH/TO/HEAVY_SCRIPT_DIRECTORY/heavy_script.sh --self-update -b 10 -rsp -u 10` | This is the command you will be running on your schedule I personally use: `bash /mnt/speed/scripts/heavy_script/heavy_script.sh --self-update -b 10 -rsp -u 10` |
|
| `Command` | `bash /PATH/TO/truetool_DIRECTORY/truetool.sh --no-color -b 14 -sup` | This is the command you will be running on your schedule, example: `bash /mnt/speed/scripts/truetool/truetool.sh -b 14 -sup` |
|
||||||
| `Run As User` | `root` | Running the script as `root` is REQUIRED. You cannot access all of the kubernetes functions without this user. |
|
| `Run As User` | `root` | Running the script as `root` is REQUIRED. You cannot access all of the kubernetes functions without this user. |
|
||||||
| `Schedule` | Up to you, I run mine everyday at `0400` | Again up to you |
|
| `Schedule` | Up to you, example: `0400` | Again up to you |
|
||||||
| `Hide Standard Output` | `False` or Unticked | I like to receive an email report of how the script ran, what apps updated etc. |
|
| `Hide Standard Output` | `False` or Un-ticked | It's best to keep an eye on updates and enable this to receive email reports |
|
||||||
| `Hide Standard Error` | `False` or Unticked | I want to see any errors that occur |
|
| `Hide Standard Error` | `False` or Un-ticked | We definitely want to see what errors occurred during updating |
|
||||||
| `Enabled` | `True` or Ticked | This will Enable the script to run on your schedule |
|
| `Enabled` | `True` or Ticked | This will Enable the script to run on your schedule |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<br >
|
<br >
|
||||||
<br >
|
<br >
|
||||||
|
|
||||||
### Additional Information
|
### Additional Information
|
||||||
|
|
||||||
#### Verbose vs Non-Verbose
|
#### TrueTool vs HeavyScript
|
||||||
- Verbose used `bash heavy_script.sh -b 5 -Srupv`
|
|
||||||
- Non-Verbose used `bash heavy_script.sh -b 5 -Srup`
|
|
||||||
|
|
||||||
| Verbose | Non-Verbose |
|
TrueTool and HeavyScript are based, in essence, based on the original (python based) TrueUpdate and TrueTool.
|
||||||
|--------- |------------- |
|
Then Support-Manager for TrueCharts, HeavyBullets8, ported this to Bash and started adding some additional logic and options for tasks we frequently needed our users to do, such as mounting PVC's.
|
||||||
|  |  |
|
|
||||||
|
|
||||||
|
After a month or so, the TrueCharts Team officially started refactoring this expanded bash-port. Due to personal reasons, HeavyBullets by then decided to separate from TrueCharts after merging the TrueCharts refactor into his own work. The beauty of OpenSource.
|
||||||
|
|
||||||
|
From this point onwards the HeavyScript and TrueTool diverged a bit.
|
||||||
|
We internally review changes within our staff team, to verify we somewhat stick to best-practices. This means, in some cases, we decided not to port certain features from HeavyScript and did decide to add features we think are useful and safe.
|
||||||
|
But this also means we can give guarantees TrueTool works optimally with our Catalog of TrueNAS SCALE Apps, as well as official Apps.
|
||||||
|
|
||||||
|
Users from HeavyScript can safely start using TrueTool, as we've made precautions to ensure the backups take over smoothly.
|
||||||
|
We, however, do _not_ advise using HeavyScript with TrueCharts Apps. Not because it's a bad App, but because we offer an alternative that is validated by our Staff.
|
||||||
|
|||||||
125
hotpatch/2212/HP1.patch
Normal file
125
hotpatch/2212/HP1.patch
Normal file
@ -0,0 +1,125 @@
|
|||||||
|
diff --git plugins/chart_releases_linux/chart_release.py plugins/chart_releases_linux/chart_release.py
|
||||||
|
index 76e3825bc0f..f65cc0eac24 100644
|
||||||
|
--- plugins/chart_releases_linux/chart_release.py
|
||||||
|
+++ plugins/chart_releases_linux/chart_release.py
|
||||||
|
@@ -606,7 +606,7 @@ async def do_delete(self, job, release_name, options):
|
||||||
|
# If we had pre-install jobs, it's possible we have leftover pods which the job did not remove
|
||||||
|
# based on dev specified settings of cleaning it up - let's remove those
|
||||||
|
for pod in await self.middleware.call('k8s.pod.query', [['metadata.namespace', '=', namespace]]):
|
||||||
|
- owner_references = pod['metadata'].get('owner_references')
|
||||||
|
+ owner_references = pod['metadata'].get('ownerReferences')
|
||||||
|
if not isinstance(owner_references, list) or all(
|
||||||
|
owner_reference.get('name') not in pre_install_jobs for owner_reference in owner_references
|
||||||
|
):
|
||||||
|
@@ -658,7 +658,7 @@ async def remove_storage_class_and_dataset(self, release_name, job=None):
|
||||||
|
pvc_volume_ds = os.path.join(release_ds, 'volumes')
|
||||||
|
for pv in await self.middleware.call(
|
||||||
|
'k8s.pv.query', [
|
||||||
|
- ['spec.csi.volume_attributes.openebs\\.io/poolname', '=', pvc_volume_ds]
|
||||||
|
+ ['spec.csi.volumeAttributes.openebs\\.io/poolname', '=', pvc_volume_ds]
|
||||||
|
]
|
||||||
|
):
|
||||||
|
await self.middleware.call('k8s.pv.delete', pv['metadata']['name'])
|
||||||
|
diff --git plugins/chart_releases_linux/resources.py plugins/chart_releases_linux/resources.py
|
||||||
|
index c7180147a5f..941de79da45 100644
|
||||||
|
--- plugins/chart_releases_linux/resources.py
|
||||||
|
+++ plugins/chart_releases_linux/resources.py
|
||||||
|
@@ -158,13 +158,13 @@ async def retrieve_pv_pvc_mapping_internal(self, chart_release):
|
||||||
|
}
|
||||||
|
|
||||||
|
for pv in chart_release['resources']['persistent_volumes']:
|
||||||
|
- claim_name = pv['spec'].get('claim_ref', {}).get('name')
|
||||||
|
+ claim_name = pv['spec'].get('claimRef', {}).get('name')
|
||||||
|
if claim_name:
|
||||||
|
csi_spec = pv['spec']['csi']
|
||||||
|
- volumes_ds = csi_spec['volume_attributes']['openebs.io/poolname']
|
||||||
|
+ volumes_ds = csi_spec['volumeAttributes']['openebs.io/poolname']
|
||||||
|
if (
|
||||||
|
os.path.join(chart_release['dataset'], 'volumes') != volumes_ds or
|
||||||
|
- csi_spec['volume_handle'] not in zfs_volumes
|
||||||
|
+ csi_spec['volumeHandle'] not in zfs_volumes
|
||||||
|
):
|
||||||
|
# We are only going to backup/restore pvc's which were consuming
|
||||||
|
# their respective storage class and we have related zfs volume present
|
||||||
|
@@ -174,8 +174,8 @@ async def retrieve_pv_pvc_mapping_internal(self, chart_release):
|
||||||
|
mapping[claim_name] = {
|
||||||
|
'name': pv_name,
|
||||||
|
'pv_details': pv,
|
||||||
|
- 'dataset': os.path.join(volumes_ds, csi_spec['volume_handle']),
|
||||||
|
- 'zv_details': zfs_volumes[csi_spec['volume_handle']],
|
||||||
|
+ 'dataset': os.path.join(volumes_ds, csi_spec['volumeHandle']),
|
||||||
|
+ 'zv_details': zfs_volumes[csi_spec['volumeHandle']],
|
||||||
|
}
|
||||||
|
return mapping
|
||||||
|
|
||||||
|
@@ -247,11 +247,11 @@ async def get_workload_storage_details(self):
|
||||||
|
# because of chart release reclaim policy being retain
|
||||||
|
for pv in await self.middleware.call(
|
||||||
|
'k8s.pv.query', [[
|
||||||
|
- 'spec.csi.volume_attributes.openebs\\.io/poolname', '^',
|
||||||
|
+ 'spec.csi.volumeAttributes.openebs\\.io/poolname', '^',
|
||||||
|
f'{os.path.join(k8s_config["dataset"], "releases")}/'
|
||||||
|
]]
|
||||||
|
):
|
||||||
|
- dataset = pv['spec']['csi']['volume_attributes']['openebs.io/poolname']
|
||||||
|
+ dataset = pv['spec']['csi']['volumeAttributes']['openebs.io/poolname']
|
||||||
|
rl = dataset.split('/', 4)
|
||||||
|
if len(rl) > 4:
|
||||||
|
mapping['persistent_volumes'][rl[3]].append(pv)
|
||||||
|
diff --git plugins/chart_releases_linux/scale_workload.py plugins/chart_releases_linux/scale_workload.py
|
||||||
|
index 117dab3a79c..e9525150278 100644
|
||||||
|
--- plugins/chart_releases_linux/scale_workload.py
|
||||||
|
+++ plugins/chart_releases_linux/scale_workload.py
|
||||||
|
@@ -246,10 +246,10 @@ async def get_workload_to_pod_mapping(self, namespace):
|
||||||
|
for r in await self.middleware.call(
|
||||||
|
f'k8s.{key}.query', [
|
||||||
|
['metadata.namespace', '=', namespace],
|
||||||
|
- ['metadata', 'rin', 'owner_references'],
|
||||||
|
+ ['metadata', 'rin', 'ownerReferences'],
|
||||||
|
], {'select': ['metadata']}
|
||||||
|
):
|
||||||
|
- for owner_reference in filter(lambda o: o.get('uid'), r['metadata']['owner_references'] or []):
|
||||||
|
+ for owner_reference in filter(lambda o: o.get('uid'), r['metadata']['ownerReferences'] or []):
|
||||||
|
mapping[key][owner_reference['uid']][r['metadata']['uid']] = r
|
||||||
|
|
||||||
|
pod_mapping = defaultdict(list)
|
||||||
|
diff --git plugins/kubernetes_linux/restore.py plugins/kubernetes_linux/restore.py
|
||||||
|
index 4897e3f8b7a..ec13a332b6e 100644
|
||||||
|
--- plugins/kubernetes_linux/restore.py
|
||||||
|
+++ plugins/kubernetes_linux/restore.py
|
||||||
|
@@ -218,7 +218,11 @@ def restore_backup(self, job, backup_name, options):
|
||||||
|
failed_pv_restores.append(f'Unable to create ZFS Volume for {pvc!r} PVC: {e}')
|
||||||
|
continue
|
||||||
|
|
||||||
|
+ # We need to safely access claim_ref vollume attribute keys as with k8s client api re-write
|
||||||
|
+ # camel casing which was done by kubernetes asyncio package is not happening anymore
|
||||||
|
pv_spec = pv['pv_details']['spec']
|
||||||
|
+ claim_ref = pv_spec.get('claim_ref') or pv_spec['claimRef']
|
||||||
|
+ pv_volume_attrs = pv_spec['csi'].get('volume_attributes') or pv_spec['csi']['volumeAttributes']
|
||||||
|
try:
|
||||||
|
self.middleware.call_sync('k8s.pv.create', {
|
||||||
|
'metadata': {
|
||||||
|
@@ -229,18 +233,18 @@ def restore_backup(self, job, backup_name, options):
|
||||||
|
'storage': pv_spec['capacity']['storage'],
|
||||||
|
},
|
||||||
|
'claimRef': {
|
||||||
|
- 'name': pv_spec['claim_ref']['name'],
|
||||||
|
- 'namespace': pv_spec['claim_ref']['namespace'],
|
||||||
|
+ 'name': claim_ref['name'],
|
||||||
|
+ 'namespace': claim_ref['namespace'],
|
||||||
|
},
|
||||||
|
'csi': {
|
||||||
|
'volumeAttributes': {
|
||||||
|
'openebs.io/poolname': RE_POOL.sub(
|
||||||
|
- f'{k8s_pool}\\1', pv_spec['csi']['volume_attributes']['openebs.io/poolname']
|
||||||
|
+ f'{k8s_pool}\\1', pv_volume_attrs['openebs.io/poolname']
|
||||||
|
)
|
||||||
|
},
|
||||||
|
- 'volumeHandle': pv_spec['csi']['volume_handle'],
|
||||||
|
+ 'volumeHandle': pv_spec['csi'].get('volume_handle') or pv_spec['csi']['volumeHandle'],
|
||||||
|
},
|
||||||
|
- 'storageClassName': pv_spec['storage_class_name'],
|
||||||
|
+ 'storageClassName': pv_spec.get('storage_class_name') or pv_spec['storageClassName'],
|
||||||
|
},
|
||||||
|
})
|
||||||
|
except Exception as e:
|
||||||
14
hotpatch/2212/HP2.patch
Normal file
14
hotpatch/2212/HP2.patch
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
diff --git plugins/kubernetes_linux/backup.py plugins/kubernetes_linux/backup.py
|
||||||
|
index 365cd1718b4..1046a64c2a5 100644
|
||||||
|
index d8a48d45f89..365cd1718b4 100644
|
||||||
|
--- plugins/kubernetes_linux/backup.py
|
||||||
|
+++ plugins/kubernetes_linux/backup.py
|
||||||
|
@@ -61,7 +61,8 @@ def backup_chart_releases(self, job, backup_name):
|
||||||
|
['metadata.namespace', '=', chart_release['namespace']]
|
||||||
|
]
|
||||||
|
)
|
||||||
|
- for secret in sorted(secrets, key=lambda d: d['metadata']['name']):
|
||||||
|
+ # We ignore this keeping in line with helm behaviour where the secret malformed is ignored by helm
|
||||||
|
+ for secret in sorted(filter(lambda d: d.get('data'), secrets), key=lambda d: d['metadata']['name']):
|
||||||
|
with open(os.path.join(secrets_dir, secret['metadata']['name']), 'w') as f:
|
||||||
|
f.write(self.middleware.call_sync('k8s.secret.export_to_yaml_internal', secret))
|
||||||
96
includes/backup.sh
Normal file
96
includes/backup.sh
Normal file
@ -0,0 +1,96 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
## Simple shortcut to just list the backups without promts and such
|
||||||
|
listBackups(){
|
||||||
|
echo -e "${BWhite}Backup Listing Tool${Color_Off}"
|
||||||
|
clear -x && echo "pulling all restore points.."
|
||||||
|
list_backups=$(cli -c 'app kubernetes list_backups' | grep -v system-update | sort -t '_' -Vr -k2,7 | tr -d " \t\r" | awk -F '|' '{print $2}' | nl | column -t)
|
||||||
|
[[ -z "$list_backups" ]] && echo -e "${IRed}No restore points available${Color_Off}" && exit || echo "Detected Backups:" && echo "$list_backups"
|
||||||
|
}
|
||||||
|
export -f listBackups
|
||||||
|
|
||||||
|
## Lists backups, except system-created backups, and promts which one to delete
|
||||||
|
deleteBackup(){
|
||||||
|
echo -e "${BWhite}Backup Deletion Tool${Color_Off}"
|
||||||
|
clear -x && echo "pulling all restore points.."
|
||||||
|
list_delete_backups=$(cli -c 'app kubernetes list_backups' | grep -v system-update | sort -t '_' -Vr -k2,7 | tr -d " \t\r" | awk -F '|' '{print $2}' | nl | column -t)
|
||||||
|
clear -x
|
||||||
|
# shellcheck disable=SC2015
|
||||||
|
[[ -z "$list_delete_backups" ]] && echo -e "${IRed}No restore points available${Color_Off}" && exit || { title; echo -e "Choose a restore point to delete\nThese may be out of order if they are not TrueTool backups" ; }
|
||||||
|
# shellcheck disable=SC2015
|
||||||
|
echo "$list_delete_backups" && read -rt 600 -p "Please type a number: " selection && restore_point=$(echo "$list_delete_backups" | grep ^"$selection " | awk '{print $2}')
|
||||||
|
[[ -z "$selection" ]] && echo "${IRed}Your selection cannot be empty${Color_Off}" && exit #Check for valid selection. If none, kill script
|
||||||
|
[[ -z "$restore_point" ]] && echo "Invalid Selection: $selection, was not an option" && exit #Check for valid selection. If none, kill script
|
||||||
|
echo -e "\nWARNING:\nYou CANNOT go back after deleting your restore point" || { echo "${IRed}FAILED${Color_Off}"; exit; }
|
||||||
|
# shellcheck disable=SC2015
|
||||||
|
echo -e "\n\nYou have chosen:\n$restore_point\n\nWould you like to continue?" && echo -e "1 Yes\n2 No" && read -rt 120 -p "Please type a number: " yesno || { echo "${IRed}FAILED${Color_Off}"; exit; }
|
||||||
|
if [[ $yesno == "1" ]]; then
|
||||||
|
echo -e "\nDeleting $restore_point" && cli -c 'app kubernetes delete_backup backup_name=''"'"$restore_point"'"' &>/dev/null && echo -e "${IGreen}Sucessfully deleted${Color_Off}" || echo -e "${IRed}Deletion FAILED${Color_Off}"
|
||||||
|
elif [[ $yesno == "2" ]]; then
|
||||||
|
echo "You've chosen NO, killing script."
|
||||||
|
else
|
||||||
|
echo -e "${IRed}Invalid Selection${Color_Off}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
export -f deleteBackup
|
||||||
|
|
||||||
|
## Creates backups and deletes backups if a "backups to keep"-count is exceeded.
|
||||||
|
# backups-to-keep takes only heavyscript and truetool created backups into account, as other backups aren't guaranteed to be sorted correctly
|
||||||
|
backup(){
|
||||||
|
echo -e "${BWhite}Backup Tool${Color_Off}"
|
||||||
|
echo -e "\nNumber of backups was set to $number_of_backups"
|
||||||
|
date=$(date '+%Y_%m_%d_%H_%M_%S')
|
||||||
|
[[ "$verbose" == "true" ]] && cli -c 'app kubernetes backup_chart_releases backup_name=''"'TrueTool_"$date"'"'
|
||||||
|
[[ -z "$verbose" ]] && echo -e "\nNew Backup Name:" && cli -c 'app kubernetes backup_chart_releases backup_name=''"'TrueTool_"$date"'"' | tail -n 1
|
||||||
|
mapfile -t list_create_backups < <(cli -c 'app kubernetes list_backups' | grep 'HeavyScript\|TrueTool_' | sort -t '_' -Vr -k2,7 | awk -F '|' '{print $2}'| tr -d " \t\r")
|
||||||
|
# shellcheck disable=SC2309
|
||||||
|
if [[ ${#list_create_backups[@]} -gt "number_of_backups" ]]; then
|
||||||
|
echo -e "\nDeleting the oldest backup(s) for exceeding limit:"
|
||||||
|
overflow=$(( ${#list_create_backups[@]} - "$number_of_backups" ))
|
||||||
|
mapfile -t list_overflow < <(cli -c 'app kubernetes list_backups' | grep "TrueTool_" | sort -t '_' -V -k2,7 | awk -F '|' '{print $2}'| tr -d " \t\r" | head -n "$overflow")
|
||||||
|
for i in "${list_overflow[@]}"
|
||||||
|
do
|
||||||
|
cli -c 'app kubernetes delete_backup backup_name=''"'"$i"'"' &> /dev/null || echo "${IRed}FAILED${Color_Off} to delete $i"
|
||||||
|
echo "$i"
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
export -f backup
|
||||||
|
|
||||||
|
## Lists available backup and prompts the users to select a backup to restore
|
||||||
|
restore(){
|
||||||
|
echo -e "${BWhite}Backup Restoration Tool${Color_Off}"
|
||||||
|
clear -x && echo "pulling restore points.."
|
||||||
|
list_restore_backups=$(cli -c 'app kubernetes list_backups' | grep "TrueTool_" | sort -t '_' -Vr -k2,7 | tr -d " \t\r" | awk -F '|' '{print $2}' | nl | column -t)
|
||||||
|
clear -x
|
||||||
|
# shellcheck disable=SC2015
|
||||||
|
[[ -z "$list_restore_backups" ]] && echo "No TrueTool restore points available" && exit || { title; echo "Choose a restore point" ; }
|
||||||
|
echo "$list_restore_backups" && read -rt 600 -p "Please type a number: " selection && restore_point=$(echo "$list_restore_backups" | grep ^"$selection " | awk '{print $2}')
|
||||||
|
[[ -z "$selection" ]] && echo "Your selection cannot be empty" && exit #Check for valid selection. If none, kill script
|
||||||
|
[[ -z "$restore_point" ]] && echo "Invalid Selection: $selection, was not an option" && exit #Check for valid selection. If none, kill script
|
||||||
|
echo -e "\nWARNING:\nThis is NOT guranteed to work\nThis is ONLY supposed to be used as a LAST RESORT\nConsider rolling back your applications instead if possible" || { echo "${IRed}FAILED${Color_Off}"; exit; }
|
||||||
|
# shellcheck disable=SC2015
|
||||||
|
echo -e "\n\nYou have chosen:\n$restore_point\n\nWould you like to continue?" && echo -e "1 Yes\n2 No" && read -rt 120 -p "Please type a number: " yesno || { echo "${IRed}FAILED${Color_Off}"; exit; }
|
||||||
|
if [[ $yesno == "1" ]]; then
|
||||||
|
echo -e "\nStarting Restore, this will take a ${BWhite}LONG${Color_Off} time."
|
||||||
|
pool=$(cli -c 'app kubernetes config' | grep -E "pool\s\|" | awk -F '|' '{print $3}' | tr -d " \t\n\r")
|
||||||
|
echo "Correcting PVC mountpoints..."
|
||||||
|
for pvc in $(zfs list -t filesystem -r "$pool"/ix-applications -o name -H | grep "/ix-applications/" | grep "volumes/pvc")
|
||||||
|
do
|
||||||
|
zfs set mountpoint=legacy "${pvc}" || echo "Fixing PVC mountpoints Failed for ${pvc}... Continuing..."
|
||||||
|
done
|
||||||
|
# Ensure readonly is turned off
|
||||||
|
if ! zfs set readonly=off "$pool"/ix-applications;then
|
||||||
|
echo -e "Error: Failed to set ZFS ReadOnly to \"off\""
|
||||||
|
echo -e "After the restore, attempt to run the following command manually:"
|
||||||
|
echo "zfs set readonly=off $pool/ix-applications"
|
||||||
|
fi
|
||||||
|
echo "Triggering restore process..."
|
||||||
|
cli -c 'app kubernetes restore_backup backup_name=''"'"$restore_point"'"' || echo "Restore ${IRed}FAILED${Color_Off}"
|
||||||
|
elif [[ $yesno == "2" ]]; then
|
||||||
|
echo "You've chosen NO, killing script. Good luck."
|
||||||
|
else
|
||||||
|
echo -e "${IRed}Invalid Selection${Color_Off}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
export -f restore
|
||||||
42
includes/chores.sh
Normal file
42
includes/chores.sh
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
helmEnable(){
|
||||||
|
echo -e "${BWhite}Enabling Helm${Color_Off}"
|
||||||
|
export KUBECONFIG=/etc/rancher/k3s/k3s.yaml && echo -e "${IGreen}Helm Enabled${Color_Off}"|| echo -e "${IRed}Helm Enable FAILED${Color_Off}"
|
||||||
|
}
|
||||||
|
export -f helmEnable
|
||||||
|
|
||||||
|
aptEnable(){
|
||||||
|
echo -e "${BWhite}Enabling Apt-Commands${Color_Off}"
|
||||||
|
chmod +x /usr/bin/apt* && echo -e "${IGreen}APT enabled${Color_Off}"|| echo -e "${IRed}APT Enable FAILED${Color_Off}"
|
||||||
|
}
|
||||||
|
export -f aptEnable
|
||||||
|
|
||||||
|
kubeapiEnable(){
|
||||||
|
local -r comment='iX Custom Rule to drop connection requests to k8s cluster from external sources'
|
||||||
|
echo -e "${BWhite}Enabling Kubernetes API${Color_Off}"
|
||||||
|
if iptables -t filter -L INPUT 2> /dev/null | grep -q "${comment}" ; then
|
||||||
|
iptables -D INPUT -p tcp -m tcp --dport 6443 -m comment --comment "${comment}" -j DROP && echo -e "${IGreen}Kubernetes API enabled${Color_Off}"|| echo -e "${IRed}Kubernetes API Enable FAILED${Color_Off}"
|
||||||
|
else
|
||||||
|
echo -e "${IGreen}Kubernetes API already enabled${Color_Off}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
export -f kubeapiEnable
|
||||||
|
|
||||||
|
# Prune unused docker images to prevent dataset/snapshot bloat related slowdowns on SCALE
|
||||||
|
prune(){
|
||||||
|
echo -e "${BWhite}Docker Prune${Color_Off}"
|
||||||
|
echo "Pruning Docker Images..."
|
||||||
|
docker image prune -af | grep "^Total" && echo -e "${IGreen}Docker Prune Successfull${Color_Off}" || echo "Docker Prune ${IRed}FAILED${Color_Off}"
|
||||||
|
|
||||||
|
# TODO Switch to middleware prune on next release
|
||||||
|
# midclt call container.prune '{"remove_unused_images": true, "remove_stopped_containers": true}' &> /dev/null && echo "Docker Prune completed"|| echo "Docker Prune ${IRed}FAILED${Color_Off}"
|
||||||
|
}
|
||||||
|
export -f prune
|
||||||
|
|
||||||
|
#
|
||||||
|
sync(){
|
||||||
|
echo -e "${BWhite}Starting Catalog Sync...${Color_Off}"
|
||||||
|
cli -c 'app catalog sync_all' &> /dev/null && echo -e "${IGreen}Catalog sync complete${Color_Off}" || echo -e "${IRed}Catalog Sync Failed${Color_Off}"
|
||||||
|
}
|
||||||
|
export -f sync
|
||||||
113
includes/colors.sh
Normal file
113
includes/colors.sh
Normal file
@ -0,0 +1,113 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
# shellcheck disable=SC2034
|
||||||
|
|
||||||
|
# Reset
|
||||||
|
Color_Off='\033[0m' # Text Reset
|
||||||
|
|
||||||
|
# Regular Colors
|
||||||
|
Black='\033[0;30m' # Black
|
||||||
|
Red='\033[0;31m' # Red
|
||||||
|
Green='\033[0;32m' # Green
|
||||||
|
Yellow='\033[0;33m' # Yellow
|
||||||
|
Blue='\033[0;34m' # Blue
|
||||||
|
Purple='\033[0;35m' # Purple
|
||||||
|
Cyan='\033[0;36m' # Cyan
|
||||||
|
White='\033[0;37m' # White
|
||||||
|
|
||||||
|
# Bold
|
||||||
|
BBlack='\033[1;30m' # Black
|
||||||
|
BRed='\033[1;31m' # Red
|
||||||
|
BGreen='\033[1;32m' # Green
|
||||||
|
BYellow='\033[1;33m' # Yellow
|
||||||
|
BBlue='\033[1;34m' # Blue
|
||||||
|
BPurple='\033[1;35m' # Purple
|
||||||
|
BCyan='\033[1;36m' # Cyan
|
||||||
|
BWhite='\033[1;37m' # White
|
||||||
|
|
||||||
|
# Underline
|
||||||
|
UBlack='\033[4;30m' # Black
|
||||||
|
URed='\033[4;31m' # Red
|
||||||
|
UGreen='\033[4;32m' # Green
|
||||||
|
UYellow='\033[4;33m' # Yellow
|
||||||
|
UBlue='\033[4;34m' # Blue
|
||||||
|
UPurple='\033[4;35m' # Purple
|
||||||
|
UCyan='\033[4;36m' # Cyan
|
||||||
|
UWhite='\033[4;37m' # White
|
||||||
|
|
||||||
|
# High Intensity
|
||||||
|
IBlack='\033[0;90m' # Black
|
||||||
|
IRed='\033[0;91m' # Red
|
||||||
|
IGreen='\033[0;92m' # Green
|
||||||
|
IYellow='\033[0;93m' # Yellow
|
||||||
|
IBlue='\033[0;94m' # Blue
|
||||||
|
IPurple='\033[0;95m' # Purple
|
||||||
|
ICyan='\033[0;96m' # Cyan
|
||||||
|
IWhite='\033[0;97m' # White
|
||||||
|
|
||||||
|
|
||||||
|
# Bold High Intensity
|
||||||
|
BIBlack='\033[1;90m' # Black
|
||||||
|
BIRed='\033[1;91m' # Red
|
||||||
|
BIGreen='\033[1;92m' # Green
|
||||||
|
BIYellow='\033[1;93m' # Yellow
|
||||||
|
BIBlue='\033[1;94m' # Blue
|
||||||
|
BIPurple='\033[1;95m' # Purple
|
||||||
|
BICyan='\033[1;96m' # Cyan
|
||||||
|
BIWhite='\033[1;97m' # White
|
||||||
|
|
||||||
|
noColor(){
|
||||||
|
# Reset
|
||||||
|
Color_Off=""
|
||||||
|
|
||||||
|
# Regular Colors
|
||||||
|
Black=""
|
||||||
|
Red=""
|
||||||
|
Green=""
|
||||||
|
Yellow=""
|
||||||
|
Blue=""
|
||||||
|
Purple=""
|
||||||
|
Cyan=""
|
||||||
|
White=""
|
||||||
|
|
||||||
|
# Bold
|
||||||
|
BBlack=""
|
||||||
|
BRed=""
|
||||||
|
BGreen=""
|
||||||
|
BYellow=""
|
||||||
|
BBlue=""
|
||||||
|
BPurple=""
|
||||||
|
BCyan=""
|
||||||
|
BWhite=""
|
||||||
|
|
||||||
|
# Underline
|
||||||
|
UBlack=""
|
||||||
|
URed=""
|
||||||
|
UGreen=""
|
||||||
|
UYellow=""
|
||||||
|
UBlue=""
|
||||||
|
UPurple=""
|
||||||
|
UCyan=""
|
||||||
|
UWhite=""
|
||||||
|
|
||||||
|
# High Intensity
|
||||||
|
IBlack=""
|
||||||
|
IRed=""
|
||||||
|
IGreen=""
|
||||||
|
IYellow=""
|
||||||
|
IBlue=""
|
||||||
|
IPurple=""
|
||||||
|
ICyan=""
|
||||||
|
IWhite=""
|
||||||
|
|
||||||
|
|
||||||
|
# Bold High Intensity
|
||||||
|
BIBlack=""
|
||||||
|
BIRed=""
|
||||||
|
BIGreen=""
|
||||||
|
BIYellow=""
|
||||||
|
BIBlue=""
|
||||||
|
BIPurple=""
|
||||||
|
BICyan=""
|
||||||
|
BIWhite=""
|
||||||
|
}
|
||||||
|
export -f noColor
|
||||||
27
includes/dns.sh
Normal file
27
includes/dns.sh
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
dns(){
|
||||||
|
echo -e "${BWhite}Service DNS Names Tool${Color_Off}"
|
||||||
|
clear -x
|
||||||
|
echo "Generating Internal Service DNS Names..."
|
||||||
|
#ignored dependency pods, may need to add more in the future.
|
||||||
|
dep_ignore="\-cronjob\-|^kube-system|\ssvclb|NAME|\-memcached\-.[^custom\-app]|\-postgresql\-.[^custom\-app]|\-redis\-.[^custom\-app]|\-mariadb\-.[^custom\-app]|\-promtail\-.[^custom\-app]"
|
||||||
|
|
||||||
|
# Pulling pod names
|
||||||
|
mapfile -t main < <(k3s kubectl get pods -A | grep -Ev "$dep_ignore" | sort)
|
||||||
|
|
||||||
|
# Pulling all ports
|
||||||
|
all_ports=$(k3s kubectl get service -A)
|
||||||
|
|
||||||
|
clear -x
|
||||||
|
count=0
|
||||||
|
for i in "${main[@]}"
|
||||||
|
do
|
||||||
|
[[ count -le 0 ]] && echo -e "\n" && ((count++))
|
||||||
|
appName=$(echo "$i" | awk '{print $2}' | sed 's/-[^-]*-[^-]*$//' | sed 's/-0//')
|
||||||
|
ixName=$(echo "$i" | awk '{print $1}')
|
||||||
|
port=$(echo "$all_ports" | grep -E "\s$appName\s" | awk '{print $6}' | grep -Eo "^[[:digit:]]+{1}")
|
||||||
|
[[ -n "$port" ]] && echo -e "$appName.$ixName.svc.cluster.local $port"
|
||||||
|
done | uniq | nl -b t | sed 's/\s\s\s$/- -------- ----/' | column -t -R 1 -N "#,DNS_Name,Port" -L
|
||||||
|
}
|
||||||
|
export -f dns
|
||||||
35
includes/help.sh
Normal file
35
includes/help.sh
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
help(){
|
||||||
|
[[ $help == "true" ]] && clear -x
|
||||||
|
echo ""
|
||||||
|
echo -e "${BWhite}Basic Utilities${Color_Off}"
|
||||||
|
echo "--mount | Initiates mounting feature, choose between unmounting and mounting PVC data"
|
||||||
|
echo "--restore | Opens a menu to restore a \"truetool\" backup that was taken on your \"ix-applications\" dataset"
|
||||||
|
echo "--delete-backup | Opens a menu to delete backups on your system"
|
||||||
|
echo "--list-backups | Prints a list of backups available"
|
||||||
|
echo "--helm-enable | Enables Helm command access on SCALE"
|
||||||
|
echo "--apt-enable | Enables Apt command access on SCALE"
|
||||||
|
echo "--kubeapi-enable | Enables external access to Kuberntes API port"
|
||||||
|
echo "--dns | List all of your applications DNS names and their web ports"
|
||||||
|
echo
|
||||||
|
echo -e "${BWhite}Update Options${Color_Off}"
|
||||||
|
echo "-U | Update all applications, ignores versions"
|
||||||
|
echo "-u | Update all applications, does not update Major releases"
|
||||||
|
echo "-b | Back-up your ix-applications dataset, specify a number after -b"
|
||||||
|
echo "-i | Add application to ignore list, one by one, see example below."
|
||||||
|
echo "-v | verbose output"
|
||||||
|
echo "-t | Set a custom timeout in seconds when checking if either an App or Mountpoint correctly Started, Stopped or (un)Mounted. Defaults to 500 seconds"
|
||||||
|
echo "-s | sync catalog"
|
||||||
|
echo "-p | Prune unused/old docker images"
|
||||||
|
echo
|
||||||
|
echo -e "${BWhite}Examples${Color_Off}"
|
||||||
|
echo "bash truetool.sh -b 14 -i portainer -i arch -i sonarr -i radarr -t 600 -vsUp"
|
||||||
|
echo "bash /mnt/tank/scripts/truetool.sh -t 150 --mount"
|
||||||
|
echo "bash /mnt/tank/scripts/truetool.sh --dns"
|
||||||
|
echo "bash /mnt/tank/scripts/truetool.sh --restore"
|
||||||
|
echo "bash /mnt/tank/scripts/truetool.sh --delete-backup"
|
||||||
|
echo
|
||||||
|
exit
|
||||||
|
}
|
||||||
|
export -f help
|
||||||
57
includes/mount.sh
Normal file
57
includes/mount.sh
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
mountPVC(){
|
||||||
|
echo -e "${BWhite}PVC Mounting Tool${Color_Off}"
|
||||||
|
clear -x
|
||||||
|
title
|
||||||
|
echo -e "1 Mount\n2 Unmount All" && read -rt 600 -p "Please type a number: " selection
|
||||||
|
[[ -z "$selection" ]] && echo "Your selection cannot be empty" && exit #Check for valid selection. If none, kill script
|
||||||
|
if [[ $selection == "1" ]]; then
|
||||||
|
list=$(k3s kubectl get pvc -A | sort -u | awk '{print NR-1, "\t" $1 "\t" $2 "\t" $4}' | column -t | sed "s/^0/ /")
|
||||||
|
echo "$list" && read -rt 120 -p "Please type a number: " selection
|
||||||
|
[[ -z "$selection" ]] && echo "Your selection cannot be empty" && exit #Check for valid selection. If none, kill script
|
||||||
|
app=$(echo -e "$list" | grep ^"$selection " | awk '{print $2}' | cut -c 4- )
|
||||||
|
[[ -z "$app" ]] && echo "Invalid Selection: $selection, was not an option" && exit #Check for valid selection. If none, kill script
|
||||||
|
pvc=$(echo -e "$list" | grep ^"$selection ")
|
||||||
|
status=$(cli -m csv -c 'app chart_release query name,status' | grep -E "^$app\b" | awk -F ',' '{print $2}'| tr -d " \t\n\r")
|
||||||
|
if [[ "$status" != "STOPPED" ]]; then
|
||||||
|
[[ -z $timeout ]] && echo -e "\nDefault Timeout: 500" && timeout=500 || echo -e "\nCustom Timeout: $timeout"
|
||||||
|
SECONDS=0 && echo -e "\nScaling down $app" && midclt call chart.release.scale "$app" '{"replica_count": 0}' &> /dev/null
|
||||||
|
else
|
||||||
|
echo -e "\n$app is already stopped"
|
||||||
|
fi
|
||||||
|
while [[ "$SECONDS" -le "$timeout" && "$status" != "STOPPED" ]]
|
||||||
|
do
|
||||||
|
status=$(cli -m csv -c 'app chart_release query name,status' | grep -E "^$app\b" | awk -F ',' '{print $2}'| tr -d " \t\n\r")
|
||||||
|
echo -e "Waiting $((timeout-SECONDS)) more seconds for $app to be STOPPED" && sleep 5
|
||||||
|
done
|
||||||
|
data_name=$(echo "$pvc" | awk '{print $3}')
|
||||||
|
volume_name=$(echo "$pvc" | awk '{print $4}')
|
||||||
|
full_path=$(zfs list | grep "$volume_name" | awk '{print $1}')
|
||||||
|
echo -e "\nMounting\n$full_path\nTo\n/mnt/truetool/$data_name" && zfs set mountpoint="/truetool/$data_name" "$full_path" && echo -e "Mounted, Use the Unmount All option to unmount\n"
|
||||||
|
exit
|
||||||
|
elif [[ $selection == "2" ]]; then
|
||||||
|
mapfile -t unmount_array < <(basename -a /mnt/truetool/* | sed "s/*//")
|
||||||
|
[[ -z ${unmount_array[*]} ]] && echo "Theres nothing to unmount" && exit
|
||||||
|
for i in "${unmount_array[@]}"
|
||||||
|
do
|
||||||
|
main=$(k3s kubectl get pvc -A | grep -E "\s$i\s" | awk '{print $1, $2, $4}')
|
||||||
|
app=$(echo "$main" | awk '{print $1}' | cut -c 4-)
|
||||||
|
pvc=$(echo "$main" | awk '{print $3}')
|
||||||
|
mapfile -t path < <(find /mnt/*/ix-applications/releases/"$app"/volumes/ -maxdepth 0 | cut -c 6-)
|
||||||
|
if [[ "${#path[@]}" -gt 1 ]]; then #if there is another app with the same name on another pool, use the current pools application, since the other instance is probably old, or unused.
|
||||||
|
echo "$i is a name used on more than one pool.. attempting to use your current kubernetes apps pool"
|
||||||
|
pool=$(cli -c 'app kubernetes config' | grep -E "dataset\s\|" | awk -F '|' '{print $3}' | awk -F '/' '{print $1}' | tr -d " \t\n\r")
|
||||||
|
full_path=$(find /mnt/"$pool"/ix-applications/releases/"$app"/volumes/ -maxdepth 0 | cut -c 6-)
|
||||||
|
zfs set mountpoint=legacy "$full_path""$pvc" && echo "$i unmounted" && rmdir /mnt/truetool/"$i" || echo "${IRed}FAILED${Color_Off} to unmount $i"
|
||||||
|
else
|
||||||
|
# shellcheck disable=SC2128
|
||||||
|
zfs set mountpoint=legacy "$path""$pvc" && echo "$i unmounted" && rmdir /mnt/truetool/"$i" || echo "${IRed}FAILED${Color_Off} to unmount $i"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
rmdir /mnt/truetool
|
||||||
|
else
|
||||||
|
echo -e "${IRed}Invalid selection, \"$selection\" was not an option${Color_Off}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
export -f mountPVC
|
||||||
72
includes/no_args.sh
Normal file
72
includes/no_args.sh
Normal file
@ -0,0 +1,72 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
# shellcheck disable=SC2034
|
||||||
|
|
||||||
|
no_args(){
|
||||||
|
echo "0 Show Help"
|
||||||
|
echo "1 List Internal Service DNS Names"
|
||||||
|
echo "2 Mount and Unmount PVC storage for easy access"
|
||||||
|
echo "3 List Backups"
|
||||||
|
echo "4 Create a Backup"
|
||||||
|
echo "5 Restore a Backup"
|
||||||
|
echo "6 Delete a Backup"
|
||||||
|
echo "7 Enable Helm Commands"
|
||||||
|
echo "8 Enable Apt and Apt-Get Commands"
|
||||||
|
echo "9 Update All Apps"
|
||||||
|
echo "10 Enable external access to Kuberntes API port"
|
||||||
|
read -rt 600 -p "Please select an option by number: " selection
|
||||||
|
|
||||||
|
case $selection in
|
||||||
|
0)
|
||||||
|
help="true"
|
||||||
|
;;
|
||||||
|
1)
|
||||||
|
dns="true"
|
||||||
|
;;
|
||||||
|
2)
|
||||||
|
mountPVC="true"
|
||||||
|
;;
|
||||||
|
3)
|
||||||
|
listBackups="true"
|
||||||
|
;;
|
||||||
|
4)
|
||||||
|
read -rt 600 -p "Please type the max number of backups to keep: " backups
|
||||||
|
re='^[0-9]+$'
|
||||||
|
number_of_backups=$backups
|
||||||
|
! [[ $backups =~ $re ]] && echo -e "Error: -b needs to be assigned an interger\n\"""$number_of_backups""\" is not an interger" >&2 && exit
|
||||||
|
[[ "$number_of_backups" -le 0 ]] && echo "Error: Number of backups is required to be at least 1" && exit
|
||||||
|
;;
|
||||||
|
5)
|
||||||
|
restore="true"
|
||||||
|
;;
|
||||||
|
6)
|
||||||
|
deleteBackup="true"
|
||||||
|
;;
|
||||||
|
7)
|
||||||
|
helmEnable="true"
|
||||||
|
;;
|
||||||
|
8)
|
||||||
|
aptEnable="true"
|
||||||
|
;;
|
||||||
|
9)
|
||||||
|
echo ""
|
||||||
|
echo "1 Update Apps Excluding likely breaking major changes"
|
||||||
|
echo "2 Update Apps Including likely breaking major changes"
|
||||||
|
read -rt 600 -p "Please select an option by number: " updateType
|
||||||
|
if [[ "$updateType" == "1" ]]; then
|
||||||
|
update_apps="true"
|
||||||
|
elif [[ "$updateType" == "2" ]]; then
|
||||||
|
update_all_apps="true"
|
||||||
|
else
|
||||||
|
echo "INVALID ENTRY" && exit 1
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
10)
|
||||||
|
kubeapiEnable="true"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "Unknown option" && exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
echo ""
|
||||||
|
}
|
||||||
|
export -f no_args
|
||||||
18
includes/patch.sh
Normal file
18
includes/patch.sh
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
patchv22120(){
|
||||||
|
echo "Applying 22.12 HotPatch 1"
|
||||||
|
( wget -q -P /tmp https://github.com/truecharts/truetool/raw/main/hotpatch/2212/HP1.patch && echo "download completed" || echo "download failed" ) && ( patch -N -s -p0 -d /usr/lib/python3/dist-packages/middlewared/ < /tmp/HP1.patch && service middlewared restart && echo "waiting 20 seconds for middleware restart..." && sleep 20 && echo "patch completed" || echo "patch failed or skipped, not critical" ) && rm -rf /tmp/HP1.patch
|
||||||
|
echo "Applying 22.12 HotPatch 2"
|
||||||
|
( wget -q -P /tmp https://github.com/truecharts/truetool/raw/main/hotpatch/2212/HP2.patch && echo "download completed" || echo "download failed" ) && ( patch -N -s -p0 -d /usr/lib/python3/dist-packages/middlewared/ < /tmp/HP2.patch && service middlewared restart && echo "waiting 20 seconds for middleware restart..." && sleep 20 && echo "patch completed" || echo "patch failed or skipped, not critical" ) && rm -rf /tmp/HP2.patch
|
||||||
|
}
|
||||||
|
export -f patchv22120
|
||||||
|
|
||||||
|
|
||||||
|
hotpatch(){
|
||||||
|
echo "Starting hotpatcher..."
|
||||||
|
if [ "$(cli -m csv -c 'system version' | awk -F '-' '{print $3}')" == "22.12.0" ]; then
|
||||||
|
patchv22120
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
export -f hotpatch
|
||||||
22
includes/title.sh
Normal file
22
includes/title.sh
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Fancy ascii title.
|
||||||
|
title(){
|
||||||
|
if [[ -z $titleShown ]]; then
|
||||||
|
echo -e "${IRed} _______ _____ _ _ ";
|
||||||
|
echo " |__ __| / ____| | | | ";
|
||||||
|
echo " | |_ __ _ _ ___| | | |__ __ _ _ __| |_ ___ ";
|
||||||
|
echo -e "${IYellow} | | '__| | | |/ _ \ | | '_ \ / _\` | '__| __/ __|";
|
||||||
|
echo " | | | | |_| | __/ |____| | | | (_| | | | |_\__ \\";
|
||||||
|
echo -e "${IGreen} __|_|_| \__,_|\___|\_____|_| |_|\__,_|_| \__|___/";
|
||||||
|
echo " |__ __| |__ __| | | ";
|
||||||
|
echo -e "${IBlue} | |_ __ _ _ ___| | ___ ___ | | ";
|
||||||
|
echo " | | '__| | | |/ _ \ |/ _ \ / _ \| | ";
|
||||||
|
echo -e "${IPurple} | | | | |_| | __/ | (_) | (_) | | ";
|
||||||
|
echo " |_|_| \__,_|\___|_|\___/ \___/|_| ";
|
||||||
|
echo " ";
|
||||||
|
echo -e "${Color_Off} ";
|
||||||
|
fi
|
||||||
|
titleShown='true'
|
||||||
|
}
|
||||||
|
export -f title
|
||||||
123
includes/update.sh
Normal file
123
includes/update.sh
Normal file
@ -0,0 +1,123 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
update_apps(){
|
||||||
|
echo -e "${BWhite}App Updater${Color_Off}"
|
||||||
|
[[ -z $timeout ]] && echo -e "Default Timeout: 500" && timeout=500 || echo -e "\nCustom Timeout: $timeout"
|
||||||
|
[[ "$timeout" -le 120 ]] && echo "Warning: Your timeout is set low and may lead to premature rollbacks or skips"
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "Creating list of Apps to update..."
|
||||||
|
|
||||||
|
# Render a list of ignored applications, so users can verify their ignores got parsed correctly.
|
||||||
|
if [[ -z ${ignore[*]} ]]; then
|
||||||
|
echo "No apps added to ignore list, continuing..."
|
||||||
|
else
|
||||||
|
echo "ignored applications:"
|
||||||
|
for ignored in "${ignore[@]}"
|
||||||
|
do
|
||||||
|
echo "${ignored}"
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
mapfile -t array < <(cli -m csv -c 'app chart_release query name,update_available,human_version,human_latest_version,container_images_update_available,status' | grep -E ",true(,|$)" | sort)
|
||||||
|
[[ -z ${array[*]} ]] && echo -e "\nThere are no updates available or middleware timed out" && return 0 || echo -e "\n${#array[@]} update(s) available:"
|
||||||
|
PIDlist=()
|
||||||
|
|
||||||
|
# Draft a list of app names, seperate from actuall execution
|
||||||
|
# This prevents outputs getting mixed together
|
||||||
|
for i in "${array[@]}"
|
||||||
|
do
|
||||||
|
app_name=$(echo "$i" | awk -F ',' '{print $1}') #print out first catagory, name.
|
||||||
|
echo "$app_name"
|
||||||
|
done
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "Updating Apps..."
|
||||||
|
|
||||||
|
# Create a background task for each update as async solution
|
||||||
|
for i in "${array[@]}"
|
||||||
|
do
|
||||||
|
executeUpdate "${i}" &
|
||||||
|
PIDlist+=($!)
|
||||||
|
done
|
||||||
|
echo ""
|
||||||
|
echo "Waiting for update results..."
|
||||||
|
|
||||||
|
# Wait for all the async updates to complete
|
||||||
|
for p in "${PIDlist[@]}"
|
||||||
|
do
|
||||||
|
wait "${p}" ||:
|
||||||
|
done
|
||||||
|
|
||||||
|
}
|
||||||
|
export -f update_apps
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# This is a combination of stopping previously-stopped apps and apps stuck Deploying after update
|
||||||
|
after_update_actions(){
|
||||||
|
SECONDS=0
|
||||||
|
count=0
|
||||||
|
sleep 15
|
||||||
|
|
||||||
|
# Keep this running and exit the endless-loop based on a timer, instead of a countered-while-loop
|
||||||
|
# shellcheck disable=SC2050
|
||||||
|
while [[ "0" != "1" ]]
|
||||||
|
do
|
||||||
|
(( count++ ))
|
||||||
|
status=$(cli -m csv -c 'app chart_release query name,update_available,human_version,human_latest_version,status' | grep "^$app_name," | awk -F ',' '{print $2}')
|
||||||
|
if [[ "$status" == "ACTIVE" && "$startstatus" == "STOPPED" ]]; then
|
||||||
|
[[ "$verbose" == "true" ]] && echo "Returing to STOPPED state.."
|
||||||
|
midclt call chart.release.scale "$app_name" '{"replica_count": 0}' &> /dev/null && echo "Stopped"|| echo "FAILED"
|
||||||
|
break
|
||||||
|
elif [[ "$SECONDS" -ge "$timeout" && "$status" == "DEPLOYING" && "$failed" != "true" ]]; then
|
||||||
|
echo -e "Error: Run Time($SECONDS) for $app_name has exceeded Timeout($timeout)\nIf this is a slow starting application, set a higher timeout with -t\nIf this applicaion is always DEPLOYING, you can disable all probes under the Healthcheck Probes Liveness section in the edit configuration\nReverting update.."
|
||||||
|
midclt call chart.release.rollback "$app_name" "{\"item_version\": \"$rollback_version\"}" &> /dev/null
|
||||||
|
[[ "$startstatus" == "STOPPED" ]] && failed="true" && after_update_actions && unset failed #run back after_update_actions function if the app was stopped prior to update
|
||||||
|
break
|
||||||
|
elif [[ "$SECONDS" -ge "$timeout" && "$status" == "DEPLOYING" && "$failed" == "true" ]]; then
|
||||||
|
echo -e "Error: Run Time($SECONDS) for $app_name has exceeded Timeout($timeout)\nThe application failed to be ACTIVE even after a rollback,\nManual intervention is required\nAbandoning"
|
||||||
|
break
|
||||||
|
elif [[ "$status" == "STOPPED" ]]; then
|
||||||
|
[[ "$count" -le 1 && "$verbose" == "true" ]] && echo "Verifying Stopped.." && sleep 15 && continue #if reports stopped on FIRST time through loop, double check
|
||||||
|
[[ "$count" -le 1 && -z "$verbose" ]] && sleep 15 && continue #if reports stopped on FIRST time through loop, double check
|
||||||
|
echo "Stopped" && break #if reports stopped any time after the first loop, assume its extermal services.
|
||||||
|
elif [[ "$status" == "ACTIVE" ]]; then
|
||||||
|
[[ "$count" -le 1 && "$verbose" == "true" ]] && echo "Verifying Active.." && sleep 15 && continue #if reports active on FIRST time through loop, double check
|
||||||
|
[[ "$count" -le 1 && -z "$verbose" ]] && sleep 15 && continue #if reports active on FIRST time through loop, double check
|
||||||
|
echo "Active" && break #if reports active any time after the first loop, assume actually active.
|
||||||
|
else
|
||||||
|
[[ "$verbose" == "true" ]] && echo "Waiting $((timeout-SECONDS)) more seconds for $app_name to be ACTIVE"
|
||||||
|
sleep 15
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
}
|
||||||
|
export -f after_update_actions
|
||||||
|
|
||||||
|
# Determine what all the required information for the App to update, check it and execute the update using the SCALE API
|
||||||
|
executeUpdate(){
|
||||||
|
app_name=$(echo "$1" | awk -F ',' '{print $1}') #print out first catagory, name.
|
||||||
|
old_app_ver=$(echo "$1" | awk -F ',' '{print $4}' | awk -F '_' '{print $1}' | awk -F '.' '{print $1}') #previous/current Application MAJOR Version
|
||||||
|
new_app_ver=$(echo "$1" | awk -F ',' '{print $5}' | awk -F '_' '{print $1}' | awk -F '.' '{print $1}') #new Application MAJOR Version
|
||||||
|
old_chart_ver=$(echo "$1" | awk -F ',' '{print $4}' | awk -F '_' '{print $2}' | awk -F '.' '{print $1}') # Old Chart MAJOR version
|
||||||
|
new_chart_ver=$(echo "$1" | awk -F ',' '{print $5}' | awk -F '_' '{print $2}' | awk -F '.' '{print $1}') # New Chart MAJOR version
|
||||||
|
status=$(echo "$1" | awk -F ',' '{print $2}') #status of the app: STOPPED / DEPLOYING / ACTIVE
|
||||||
|
startstatus=$status
|
||||||
|
diff_app=$(diff <(echo "$old_app_ver") <(echo "$new_app_ver")) #caluclating difference in major app versions
|
||||||
|
diff_chart=$(diff <(echo "$old_chart_ver") <(echo "$new_chart_ver")) #caluclating difference in Chart versions
|
||||||
|
old_full_ver=$(echo "$1" | awk -F ',' '{print $4}') #Upgraded From
|
||||||
|
new_full_ver=$(echo "$1" | awk -F ',' '{print $5}') #Upraded To
|
||||||
|
rollback_version=$(echo "$1" | awk -F ',' '{print $4}' | awk -F '_' '{print $2}')
|
||||||
|
printf '%s\0' "${ignore[@]}" | grep -iFxqz "${app_name}" && echo -e "\n$app_name\nIgnored, skipping" && return #If application is on ignore list, skip
|
||||||
|
if [[ "$diff_app" == "$diff_chart" || "$update_all_apps" == "true" ]]; then #continue to update
|
||||||
|
[[ "$verbose" == "true" ]] && echo "Updating.."
|
||||||
|
# shellcheck disable=SC2015
|
||||||
|
cli -c 'app chart_release upgrade release_name=''"'"$app_name"'"' &> /dev/null && echo -e "Updated $app_name\n$old_full_ver\n$new_full_ver" && after_update_actions || { echo -e "$app_name: update ${IRed}FAILED${Color_Off}"; return; }
|
||||||
|
else
|
||||||
|
echo -e "\n$app_name\nMajor Release, update manually"
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
export -f executeUpdate
|
||||||
31
includes/update_self.sh
Normal file
31
includes/update_self.sh
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
## AutoUpdate TrueTool using Git
|
||||||
|
updater(){
|
||||||
|
echo -e "${BWhite}Checking for updates...${Color_Off}"
|
||||||
|
git remote set-url origin "${targetRepo}"
|
||||||
|
BRANCH=$(git rev-parse --abbrev-ref HEAD)
|
||||||
|
git fetch -q
|
||||||
|
git update-index -q --refresh
|
||||||
|
if [[ $(git status --branch --porcelain) == *"behind"* ]]; then
|
||||||
|
echo -e "${IPurple}TrueTool requires update${Color_Off}"
|
||||||
|
git reset --hard -q
|
||||||
|
git checkout -q "${BRANCH}"
|
||||||
|
git pull -q
|
||||||
|
echo "script updated"
|
||||||
|
if [[ "$CHANGED" == "true" ]]; then
|
||||||
|
echo "LOOP DETECTED, exiting"
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
echo "restarting script after update..."
|
||||||
|
export CHANGED="true"
|
||||||
|
. "${SCRIPT_DIR}/truetool.sh" "$@"
|
||||||
|
exit
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo -e "${IGreen}script up-to-date${Color_Off}"
|
||||||
|
export CHANGED="false"
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
}
|
||||||
|
export -f updater
|
||||||
179
truetool.sh
Normal file
179
truetool.sh
Normal file
@ -0,0 +1,179 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Constants
|
||||||
|
SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]:-$0}"; )" &> /dev/null && pwd 2> /dev/null; )";
|
||||||
|
dir=$(basename "$SCRIPT_DIR")
|
||||||
|
|
||||||
|
# Change this if you want to fork the project
|
||||||
|
enableUpdate="true"
|
||||||
|
targetRepo="https://github.com/truecharts/truetool.git"
|
||||||
|
|
||||||
|
# CD to the folder containing the script to ensure consistent runs
|
||||||
|
cd "${SCRIPT_DIR}" || echo -e "ERROR: Something went wrong accessing the script directory"
|
||||||
|
|
||||||
|
# Includes
|
||||||
|
# shellcheck source=includes/backup.sh
|
||||||
|
source includes/backup.sh
|
||||||
|
# shellcheck source=includes/chores.sh
|
||||||
|
source includes/chores.sh
|
||||||
|
# shellcheck source=includes/colors.sh
|
||||||
|
source includes/colors.sh
|
||||||
|
# shellcheck source=includes/dns.sh
|
||||||
|
source includes/dns.sh
|
||||||
|
# shellcheck source=includes/help.sh
|
||||||
|
source includes/help.sh
|
||||||
|
# shellcheck source=includes/help.sh
|
||||||
|
source includes/patch.sh
|
||||||
|
# shellcheck source=includes/mount.sh
|
||||||
|
source includes/mount.sh
|
||||||
|
# shellcheck source=includes/no_args.sh
|
||||||
|
source includes/no_args.sh
|
||||||
|
# shellcheck source=includes/title.sh
|
||||||
|
source includes/title.sh
|
||||||
|
# shellcheck source=includes/update.sh
|
||||||
|
source includes/update.sh
|
||||||
|
# shellcheck source=includes/update_self.sh
|
||||||
|
source includes/update_self.sh
|
||||||
|
|
||||||
|
#If no argument is passed, set flag to show menu
|
||||||
|
if [[ -z "$*" || "-" == "$*" || "--" == "$*" ]]; then
|
||||||
|
no_args="true"
|
||||||
|
else
|
||||||
|
|
||||||
|
# Parse script options
|
||||||
|
while getopts ":si:b:t:uUpSv-:" opt
|
||||||
|
do
|
||||||
|
case $opt in
|
||||||
|
-)
|
||||||
|
case "${OPTARG}" in
|
||||||
|
help)
|
||||||
|
help="true"
|
||||||
|
;;
|
||||||
|
dns)
|
||||||
|
dns="true"
|
||||||
|
;;
|
||||||
|
mount)
|
||||||
|
mountPVC="true"
|
||||||
|
;;
|
||||||
|
restore)
|
||||||
|
restore="true"
|
||||||
|
;;
|
||||||
|
delete-backup)
|
||||||
|
deleteBackup="true"
|
||||||
|
;;
|
||||||
|
list-backups)
|
||||||
|
listBackups="true"
|
||||||
|
;;
|
||||||
|
helm-enable)
|
||||||
|
helmEnable="true"
|
||||||
|
;;
|
||||||
|
apt-enable)
|
||||||
|
aptEnable="true"
|
||||||
|
;;
|
||||||
|
kubeapi-enable)
|
||||||
|
kubeapiEnable="true"
|
||||||
|
;;
|
||||||
|
no-color)
|
||||||
|
noColor
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo -e "Invalid Option \"--$OPTARG\"\n" && help
|
||||||
|
exit
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
\?)
|
||||||
|
echo -e "Invalid Option \"-$OPTARG\"\n" && help
|
||||||
|
exit
|
||||||
|
;;
|
||||||
|
:)
|
||||||
|
echo -e "Option: \"-$OPTARG\" requires an argument\n" && help
|
||||||
|
exit
|
||||||
|
;;
|
||||||
|
b)
|
||||||
|
re='^[0-9]+$'
|
||||||
|
number_of_backups=$OPTARG
|
||||||
|
! [[ $OPTARG =~ $re ]] && echo -e "Error: -b needs to be assigned an interger\n\"""$number_of_backups""\" is not an interger" >&2 && exit
|
||||||
|
[[ "$number_of_backups" -le 0 ]] && echo "Error: Number of backups is required to be at least 1" && exit
|
||||||
|
;;
|
||||||
|
i)
|
||||||
|
ignore+=("$OPTARG")
|
||||||
|
;;
|
||||||
|
t)
|
||||||
|
re='^[0-9]+$'
|
||||||
|
timeout=$OPTARG
|
||||||
|
! [[ $timeout =~ $re ]] && echo -e "Error: -t needs to be assigned an interger\n\"""$timeout""\" is not an interger" >&2 && exit
|
||||||
|
;;
|
||||||
|
s)
|
||||||
|
sync="true"
|
||||||
|
;;
|
||||||
|
U)
|
||||||
|
update_all_apps="true"
|
||||||
|
;;
|
||||||
|
u)
|
||||||
|
update_apps="true"
|
||||||
|
;;
|
||||||
|
p)
|
||||||
|
prune="true"
|
||||||
|
;;
|
||||||
|
v)
|
||||||
|
verbose="true"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo -e "Invalid Option \"--$OPTARG\"\n" && help
|
||||||
|
exit
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
title
|
||||||
|
|
||||||
|
[[ "$enableUpdate" == "true" ]] && updater "$@"
|
||||||
|
|
||||||
|
## Always check if a hotpatch needs to be applied
|
||||||
|
hotpatch
|
||||||
|
|
||||||
|
# Show menu if menu flag is set
|
||||||
|
if [[ "$no_args" == "true" ]]; then
|
||||||
|
no_args
|
||||||
|
fi
|
||||||
|
|
||||||
|
## Exit if incompatable functions are called
|
||||||
|
[[ "$update_all_apps" == "true" && "$update_apps" == "true" ]] && echo -e "-U and -u cannot BOTH be called" && exit
|
||||||
|
|
||||||
|
## Exit if unsafe combinations are used
|
||||||
|
# Restore and update right after eachother, might cause super weird issues tha are hard to bugtrace
|
||||||
|
[[ ( "$update_all_apps" == "true" || "$update_apps" == "true" ) && ( "$restore" == "true" ) ]] && echo -e "Update and Restore cannot both be done in the same run..." && exit
|
||||||
|
|
||||||
|
# Backup Deletion is generally considered to be a "once in a while" thing and not great to sync with automated updates for that reason
|
||||||
|
[[ ( "$update_all_apps" == "true" || "$update_apps" == "true" ) && ( "$deleteBackup" == "true" ) ]] && echo -e "Update Backup-Deletion cannot both be done in the same run..." && exit
|
||||||
|
|
||||||
|
# Backup Deletion is generally considered to be a "once in a while" thing and not great to sync with automated updates for that reason
|
||||||
|
[[ ( "$update_all_apps" == "true" || "$update_apps" == "true" ) && ( "$deleteBackup" == "true" ) ]] && echo -e "Update and Backup-Deletion cannot both be done in the same run..." && exit
|
||||||
|
|
||||||
|
# Backup listing is a printout, which would either clutter the output or be already outdated when combined with backup
|
||||||
|
[[ ( "$update_all_apps" == "true" || "$update_apps" == "true" ) && ( "$listBackups" == "true" ) ]] && echo -e "Update and Listing Backups cannot both be done in the same run..." && exit
|
||||||
|
|
||||||
|
# Backup backup would be done after a backup is restored, which would lead to a backup that is... the same as the one restored...
|
||||||
|
[[ ( "$restore" == "true" && "$number_of_backups" -ge 1 )]] && echo -e "Restoring a backup and making a backup cannot both be done in the same run..." && exit
|
||||||
|
|
||||||
|
# While technically possible, this is asking for user error... where a user by habit mistakes one prompt, for the other.
|
||||||
|
[[ ( "$restore" == "true" && "$deleteBackup" == "true" )]] && echo -e "restoring a backup and deleting a backup cannot both be done in the same run..." && exit
|
||||||
|
|
||||||
|
|
||||||
|
# Continue to call functions in specific order
|
||||||
|
[[ "$help" == "true" ]] && help
|
||||||
|
[[ "$helmEnable" == "true" ]] && helmEnable
|
||||||
|
[[ "$aptEnable" == "true" ]] && aptEnable
|
||||||
|
[[ "$kubeapiEnable" == "true" ]] && kubeapiEnable
|
||||||
|
[[ "$aptEnable" == "true" || "$helmEnable" == "true" || "$kubeapiEnable" == "true" ]] && exit
|
||||||
|
[[ "$listBackups" == "true" ]] && listBackups && exit
|
||||||
|
[[ "$deleteBackup" == "true" ]] && deleteBackup && exit
|
||||||
|
[[ "$dns" == "true" ]] && dns && exit
|
||||||
|
[[ "$restore" == "true" ]] && restore && exit
|
||||||
|
[[ "$mountPVC" == "true" ]] && mountPVC && exit
|
||||||
|
[[ "$number_of_backups" -ge 1 ]] && backup
|
||||||
|
[[ "$sync" == "true" ]] && sync
|
||||||
|
[[ "$update_all_apps" == "true" || "$update_apps" == "true" ]] && update_apps
|
||||||
|
[[ "$prune" == "true" ]] && prune
|
||||||
Loading…
Reference in New Issue
Block a user