Skip to content

Commit 89acf80

Browse files
ansibleguyansibleguy
committed
changes for better TM compliance
1 parent 91c7162 commit 89acf80

File tree

170 files changed

+194
-165
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

170 files changed

+194
-165
lines changed

‎.github/ISSUE_TEMPLATE/features.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ body:
1212
Please make sure to go through these steps **before opening an issue**:
1313
1414
- [ ] Read the documentation to make sure the feature does not yet exist:
15-
[Docs](https://ansible-webui.readthedocs.io/)
15+
[Docs](https://webui.ansibleguy.net/)
1616
1717
- [ ] Make sure the feature is in-scope. We cannot extend the basic functionality of Ansible itself:
1818
[Ansible Docs](https://docs.ansible.com/ansible/2.8/user_guide/playbooks_best_practices.html#directory-layout)

‎.github/ISSUE_TEMPLATE/problem.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ body:
1111
value: |
1212
Please make sure to go through these steps **before opening an issue**:
1313
14-
- [ ] Read the documentation: [Docs](https://ansible-webui.readthedocs.io/)
14+
- [ ] Read the documentation: [Docs](https://webui.ansibleguy.net/)
1515
16-
- [ ] Read the troubleshooting info: [Troubleshooting](https://ansible-webui.readthedocs.io/en/latest/usage/troubleshooting.html)
16+
- [ ] Read the troubleshooting info: [Troubleshooting](https://webui.ansibleguy.net/en/latest/usage/troubleshooting.html)
1717
18-
- [ ] Check if there are existing [issues](https://github.com/ansibleguy/ansible-webui/issues)
19-
or [discussions](https://github.com/ansibleguy/ansible-webui/discussions) regarding your topic
18+
- [ ] Check if there are existing [issues](https://github.com/ansibleguy/webui/issues)
19+
or [discussions](https://github.com/ansibleguy/webui/discussions) regarding your topic
2020
2121
- type: textarea
2222
id: versions

‎.github/workflows/release.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
set +e
4646
echo 'RUNNING APP'
4747
export AW_DB="/tmp/$(date +%s).aw.db"
48-
timeout 20 python3 -m ansible-webui
48+
timeout 20 python3 -m ansibleguy-webui
4949
ec="$?"
5050
5151
echo 'CLEANUP'

‎.github/workflows/test.yml

+17-17
Original file line numberDiff line numberDiff line change
@@ -44,54 +44,54 @@ jobs:
4444
- name: Testing DB migrations for errors (1/3)
4545
run: |
4646
export AW_DB="/tmp/$(date +%s).e1.aw.db"
47-
rm -rf src/ansible-webui/aw/migrations/*
47+
rm -rf src/ansibleguy-webui/aw/migrations/*
4848
python3 manage.py makemigrations
49-
working-directory: src/ansible-webui/
49+
working-directory: src/ansibleguy-webui/
5050

5151
- name: Testing DB migrations for warnings (1/3)
5252
run: |
5353
export AW_DB="/tmp/$(date +%s).w1.aw.db"
54-
rm -rf src/ansible-webui/aw/migrations/*
54+
rm -rf src/ansibleguy-webui/aw/migrations/*
5555
m1=$(python3 manage.py makemigrations 2>&1)
5656
if echo "$m1" | grep -q 'WARNING'; then exit 1;fi
57-
working-directory: src/ansible-webui/
57+
working-directory: src/ansibleguy-webui/
5858

5959
- name: Testing DB migrations for errors (2/3)
6060
run: |
6161
export AW_DB="/tmp/$(date +%s).e2.aw.db"
62-
rm -rf src/ansible-webui/aw/migrations/*
62+
rm -rf src/ansibleguy-webui/aw/migrations/*
6363
python3 manage.py makemigrations aw
64-
working-directory: src/ansible-webui/
64+
working-directory: src/ansibleguy-webui/
6565

6666
- name: Testing DB migrations for warnings (2/3)
6767
run: |
6868
export AW_DB="/tmp/$(date +%s).w2.aw.db"
69-
rm -rf src/ansible-webui/aw/migrations/*
69+
rm -rf src/ansibleguy-webui/aw/migrations/*
7070
m2=$(python3 manage.py migrate aw 2>&1)
7171
if echo "$m2" | grep -q 'WARNING'; then exit 1;fi
72-
working-directory: src/ansible-webui/
72+
working-directory: src/ansibleguy-webui/
7373

7474
- name: Testing DB migrations for errors (3/3)
7575
run: |
7676
export AW_DB="/tmp/$(date +%s).e3.aw.db"
77-
rm -rf src/ansible-webui/aw/migrations/*
77+
rm -rf src/ansibleguy-webui/aw/migrations/*
7878
python3 manage.py migrate
79-
working-directory: src/ansible-webui/
79+
working-directory: src/ansibleguy-webui/
8080

8181
- name: Testing DB migrations for warnings (3/3)
8282
run: |
8383
export AW_DB="/tmp/$(date +%s).w3.aw.db"
84-
rm -rf src/ansible-webui/aw/migrations/*
84+
rm -rf src/ansibleguy-webui/aw/migrations/*
8585
m3=$(python3 manage.py migrate 2>&1)
8686
if echo "$m3" | grep -q 'WARNING'; then exit 1;fi
87-
working-directory: src/ansible-webui/
87+
working-directory: src/ansibleguy-webui/
8888

8989
- name: Testing to start Ansible-WebUI
9090
run: |
9191
set +e
9292
export AW_DB="/tmp/$(date +%s).aw.db"
93-
rm -rf src/ansible-webui/aw/migrations/*
94-
timeout 10 python3 src/ansible-webui
93+
rm -rf src/ansibleguy-webui/aw/migrations/*
94+
timeout 10 python3 src/ansibleguy-webui
9595
ec="$?"
9696
if [[ "$ec" != "124" ]]
9797
then
@@ -109,8 +109,8 @@ jobs:
109109
export AW_DB="/tmp/$(date +%s).aw.db"
110110
export AW_ADMIN='tester'
111111
export AW_ADMIN_PWD='someSecret!Pwd'
112-
rm -rf src/ansible-webui/aw/migrations/*
113-
python3 src/ansible-webui/ >/dev/null 2>/dev/null &
112+
rm -rf src/ansibleguy-webui/aw/migrations/*
113+
python3 src/ansibleguy-webui/ >/dev/null 2>/dev/null &
114114
sleep 5
115115
116116
echo 'WEB-UI INTEGRATION TESTS'
@@ -119,7 +119,7 @@ jobs:
119119
120120
echo 'API INTEGRATION TESTS'
121121
echo 'Create API key'
122-
api_key="$(python3 src/ansible-webui/cli.py -f api-key -a create -p "$AW_ADMIN" | grep 'Key=' | cut -d '=' -f2)"
122+
api_key="$(python3 src/ansibleguy-webui/cli.py -f api-key -a create -p "$AW_ADMIN" | grep 'Key=' | cut -d '=' -f2)"
123123
export AW_API_KEY="$api_key"
124124
sleep 1
125125
python3 test/integration/api/main.py

‎.pylintrc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[MASTER]
2-
init-hook='import sys; sys.path.append("src/ansible-webui/")'
2+
init-hook='import sys; sys.path.append("src/ansibleguy-webui/")'
33

44
[MAIN]
55

@@ -56,7 +56,7 @@ ignore=CVS
5656
# format. Because '\\' represents the directory delimiter on Windows systems,
5757
# it can't be used as an escape character.
5858
ignore-paths=venv/*,
59-
src/ansible-webui/aw/migrations/*
59+
src/ansibleguy-webui/aw/migrations/*
6060

6161
# Files or directories matching the regular expression patterns are skipped.
6262
# The regex matches against base names, not paths. The default value ignores

‎CHANGELOG.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
* Privilege System - Manager Groups
1414
* Password-Change UI
1515
* Docker
16-
* Support to [run as unprivileged user](https://ansible-webui.readthedocs.io/en/latest/usage/docker.html#unprivileged)
17-
* [Image with AWS-CLI support](https://ansible-webui.readthedocs.io/en/latest/usage/docker.html#aws-cli-support)
18-
* Enhanced handling of [SQLite Write-Locks](https://github.com/ansibleguy/ansible-webui/issues/6)
16+
* Support to [run as unprivileged user](https://webui.ansibleguy.net/en/latest/usage/docker.html#unprivileged)
17+
* [Image with AWS-CLI support](https://webui.ansibleguy.net/en/latest/usage/docker.html#aws-cli-support)
18+
* Enhanced handling of [SQLite Write-Locks](https://github.com/ansibleguy/webui/issues/6)
1919

2020

2121
### 0.0.9

‎CONTRIBUTE.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ We're also open to allow co-maintainers.
66

77
## What to contribute?
88

9-
* [Find and report issues/bugs](https://github.com/ansibleguy/ansible-webui/issues/new)
10-
* [Start Discussions about Implementations/Optimizations](https://github.com/ansibleguy/ansible-webui/discussions/new/choose)
9+
* [Find and report issues/bugs](https://github.com/ansibleguy/webui/issues/new)
10+
* [Start Discussions about Implementations/Optimizations](https://github.com/ansibleguy/webui/discussions/new/choose)
1111
* Help optimizing/polishing the frontend is very welcome
1212
* Fix/optimize styles/css
1313
* Extend/fix/optimize JS
1414

1515
* Add Unit-Tests (*pytest*)
16-
* Add [Integration-Tests](https://github.com/ansibleguy/ansible-webui/tree/latest/test/integration) for the Web-UI and/or API
16+
* Add [Integration-Tests](https://github.com/ansibleguy/webui/tree/latest/test/integration) for the Web-UI and/or API
1717

18-
Read into the [Troubleshooting Guide](https://ansible-webui.readthedocs.io/en/latest/usage/troubleshooting.html) to get some insight on how the stack works.
18+
Read into the [Troubleshooting Guide](https://webui.ansibleguy.net/en/latest/usage/troubleshooting.html) to get some insight on how the stack works.
1919

2020
----
2121

@@ -33,7 +33,7 @@ Read into the [Troubleshooting Guide](https://ansible-webui.readthedocs.io/en/la
3333

3434
```bash
3535
# download
36-
git clone https://github.com/ansibleguy/ansible-webui
36+
git clone https://github.com/ansibleguy/webui
3737

3838
# install dependencies (venv recommended)
3939
cd ansible-webui
@@ -42,15 +42,15 @@ bash scripts/update_version.sh
4242
export AW_VERSION="$(cat VERSION)"
4343

4444
# run
45-
python3 src/ansible-webui/
45+
python3 src/ansibleguy-webui/
4646
```
4747

4848
### Using Docker
4949

5050
```bash
51-
docker image pull ansible0guy/ansible-webui:dev
51+
docker image pull ansible0guy/webui:dev
5252
cd ${PATH_TO_SRC} # repository root directory
53-
docker run -it --name ansible-webui-dev --publish 127.0.0.1:8000:8000 --volume /tmp/awtest:/data --volume $(pwd):/aw ansible0guy/ansible-webui:dev
53+
docker run -it --name ansible-webui-dev --publish 127.0.0.1:8000:8000 --volume /tmp/awtest:/data --volume $(pwd):/aw ansible0guy/webui:dev
5454
```
5555

5656
----

‎MANIFEST.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
recursive-include src/ansible-webui/*
1+
recursive-include src/ansibleguy-webui/*
22
include requirements.txt

‎README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Ansible WebUI
2-
3-
[![Documentation](https://readthedocs.org/projects/ansible-webui/badge/?version=latest)](https://ansible-webui.readthedocs.io/en/latest/?badge=latest)
4-
[![Lint](https://github.com/ansibleguy/ansible-webui/actions/workflows/lint.yml/badge.svg?branch=latest)](https://github.com/ansibleguy/ansible-webui/actions/workflows/lint.yml)
5-
[![Test](https://github.com/ansibleguy/ansible-webui/actions/workflows/test.yml/badge.svg?branch=latest)](https://github.com/ansibleguy/ansible-webui/actions/workflows/test.yml)
1+
# Basic WebUI for using Ansible
62

3+
[![Documentation](https://readthedocs.org/projects/ansible-webui/badge/?version=latest)](https://webui.ansibleguy.net/en/latest/?badge=latest)
4+
[![Lint](https://github.com/ansibleguy/webui/actions/workflows/lint.yml/badge.svg?branch=latest)](https://github.com/ansibleguy/webui/actions/workflows/lint.yml)
5+
[![Test](https://github.com/ansibleguy/webui/actions/workflows/test.yml/badge.svg?branch=latest)](https://github.com/ansibleguy/webui/actions/workflows/test.yml)
76

7+
**DISCLAIMER**: This is an **unofficial community project**! Do not confuse it with the vanilla [Ansible](https://ansible.com/) product!
88

99
The goal is to allow users to quickly install & run a WebUI for using Ansible locally.
1010

@@ -20,17 +20,17 @@ Keep it simple.
2020

2121
```bash
2222
# install
23-
python3 -m pip install ansible-webui
23+
python3 -m pip install ansibleguy-webui
2424

2525
# run
26-
python3 -m ansible-webui
26+
python3 -m ansibleguy-webui
2727
```
2828

2929
### Docker
3030

3131
```bash
32-
docker image pull ansible0guy/ansible-webui:latest
33-
docker run -d --name ansible-webui --publish 127.0.0.1:8000:8000 --volume $(pwd)/ansible/data:/data --volume $(pwd)/ansible/play:/play ansible-webui:latest
32+
docker image pull ansible0guy/webui:latest
33+
docker run -d --name ansible-webui --publish 127.0.0.1:8000:8000 --volume $(pwd)/ansible/data:/data --volume $(pwd)/ansible/play:/play ansible0guy/webui:latest
3434
```
3535

3636
----
@@ -45,17 +45,17 @@ Login: User `demo`, Password `Ansible1337`
4545

4646
## Usage
4747

48-
[Documentation](http://ansible-webui.readthedocs.io/)
48+
[Documentation](http://webui.ansibleguy.net/)
4949

5050
----
5151

5252
## Contribute
5353

54-
Feel free to contribute to this project using [pull-requests](https://github.com/ansibleguy/ansible-webui/pulls), [issues](https://github.com/ansibleguy/ansible-webui/issues) and [discussions](https://github.com/ansibleguy/ansible-webui/discussions)!
54+
Feel free to contribute to this project using [pull-requests](https://github.com/ansibleguy/webui/pulls), [issues](https://github.com/ansibleguy/webui/issues) and [discussions](https://github.com/ansibleguy/webui/discussions)!
5555

56-
Testers are also very welcome! Please [give feedback](https://github.com/ansibleguy/ansible-webui/discussions)
56+
Testers are also very welcome! Please [give feedback](https://github.com/ansibleguy/webui/discussions)
5757

58-
See also: [Contributing](https://github.com/ansibleguy/ansible-webui/blob/latest/CONTRIBUTE.md)
58+
See also: [Contributing](https://github.com/ansibleguy/webui/blob/latest/CONTRIBUTE.md)
5959

6060
----
6161

‎config/systemd_service.conf

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
# when using with a virtual-environment
44
[Unit]
5-
Description=Ansible WebUI Service
6-
Documentation=https://ansible-webui.readthedocs.io/
7-
Documentation=https://github.com/ansibleguy/ansible-webui
5+
Description=AnsibleGuy WebUI Service
6+
Documentation=https://webui.ansibleguy.net/
7+
Documentation=https://github.com/ansibleguy/webui
88

99
[Service]
1010
Type=simple
@@ -30,9 +30,9 @@ WantedBy=multi-user.target
3030

3131
# without a venv
3232
[Unit]
33-
Description=Ansible WebUI Service
34-
Documentation=https://ansible-webui.readthedocs.io/
35-
Documentation=https://github.com/ansibleguy/ansible-webui
33+
Description=AnsibleGuy WebUI Service
34+
Documentation=https://webui.ansibleguy.net/
35+
Documentation=https://github.com/ansibleguy/webui
3636

3737
[Service]
3838
Type=simple

‎docker/Dockerfile_dev

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
FROM python:3.10-alpine
22

3-
# BUILD: docker build -f Dockerfile_dev -t ansible0guy/ansible-webui:dev --no-cache .
3+
# BUILD: docker build -f Dockerfile_dev -t ansible0guy/webui:dev --no-cache .
44
# RUN: docker run -it --name ansible-webui-dev --publish 127.0.0.1:8000:8000 --volume /tmp/awtest:/data --volume $(pwd):/aw ansible-webui:dev
55

66
RUN apk add --no-cache ansible-core openssh-client sshpass && \

‎docker/Dockerfile_production

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ARG AW_VERSION
77

88
RUN apk add --no-cache git git-lfs ansible-core openssh-client sshpass && \
99
pip install --no-cache-dir --upgrade pip 2>/dev/null && \
10-
pip install --no-cache-dir "git+https://github.com/ansibleguy/ansible-webui.git@${AW_VERSION}" && \
10+
pip install --no-cache-dir "git+https://github.com/ansibleguy/webui.git@${AW_VERSION}" && \
1111
mkdir -p /play /data/log
1212

1313
ENV AW_VERSION=${AW_VERSION} \

‎docker/Dockerfile_production_aws

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ ARG AW_VERSION
22
ARG AW_USER=aw
33

44
# references:
5-
# https://github.com/ansibleguy/ansible-webui/discussions/5
5+
# https://github.com/ansibleguy/webui/discussions/5
66
# https://github.com/aws/session-manager-plugin/issues/12#issuecomment-972880203
77
# https://github.com/aws/session-manager-plugin/blob/mainline/Dockerfile
88

@@ -21,7 +21,7 @@ RUN apt -y update && apt -y upgrade && apt -y install rpm tar gzip wget zip && a
2121
make release && \
2222
/go/src/github.com/session-manager-plugin/bin/linux_amd64_plugin/session-manager-plugin --version
2323

24-
FROM ansible0guy/ansible-webui-unprivileged:${AW_VERSION}
24+
FROM ansible0guy/webui-unprivileged:${AW_VERSION}
2525
USER root
2626
RUN apk add py3-boto3 aws-cli
2727
COPY --from=ssm-builder /go/src/github.com/session-manager-plugin/bin/linux_amd64_plugin/session-manager-plugin /usr/bin/

‎docker/Dockerfile_production_unprivileged

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ARG AW_USER=aw
1212

1313
RUN apk add --no-cache git git-lfs ansible-core openssh-client sshpass && \
1414
pip install --no-cache-dir --upgrade pip 2>/dev/null && \
15-
pip install --no-cache-dir "git+https://github.com/ansibleguy/ansible-webui.git@${AW_VERSION}" && \
15+
pip install --no-cache-dir "git+https://github.com/ansibleguy/webui.git@${AW_VERSION}" && \
1616
adduser --uid ${AW_UID} --home /home/ansible-webui --shell /usr/sbin/nologin --disabled-password ${AW_USER} ${AW_USER} && \
1717
mkdir -p /play /data/log && \
1818
chown -R ${AW_USER}:${AW_USER} /data /play

‎docker/entrypoint_dev.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ pip install --upgrade -r /aw/requirements.txt >/dev/null
1111

1212
. /entrypoint_requirements.sh
1313

14-
python3 /aw/src/ansible-webui/
14+
python3 /aw/src/ansibleguy-webui/

‎docker/entrypoint_unstable.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
. /entrypoint_requirements.sh
44

55
echo 'INSTALLING/UPGRADING latest..'
6-
pip install --no-warn-script-location --upgrade --no-cache-dir "git+https://github.com/ansibleguy/ansible-webui.git@latest" >/dev/null
6+
pip install --no-warn-script-location --upgrade --no-cache-dir "git+https://github.com/ansibleguy/webui.git@latest" >/dev/null
77

88
python3 -m ansible-webui

‎docs/source/_include/head.rst

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
.. tip::
2-
Check out `the repository on GitHub <https://github.com/ansibleguy/ansible-webui>`_
2+
Check out `the repository on GitHub <https://github.com/ansibleguy/webui>`_
33

44
Check out the demo at: `demo.webui.ansibleguy.net <https://demo.webui.ansibleguy.net>`_ |
55
Login: User :code:`demo`, Password :code:`Ansible1337`
6+
7+
.. warning::
8+
**DISCLAIMER**: This is an **unofficial community project**! Do not confuse it with the vanilla `Ansible <https://ansible.com/>`_ product!

‎docs/source/conf.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
from datetime import datetime
22

33
# pylint: disable=W0622
4+
_logo = 'https://raw.githubusercontent.com/ansibleguy/webui/latest/src/ansibleguy-webui/aw/static/img/ansible.svg'
45

5-
project = 'Ansible WebUI'
6+
project = 'AnsibleGuy WebUI'
67
copyright = f'{datetime.now().year}, AnsibleGuy'
78
author = 'AnsibleGuy'
89
extensions = ['sphinx_rtd_theme']
910
templates_path = ['_templates']
1011
exclude_patterns = []
1112
html_theme = 'sphinx_rtd_theme'
1213
html_static_path = ['_static']
13-
html_logo = 'https://raw.githubusercontent.com/ansible/logos/main/vscode-ansible-logo/vscode-ansible.svg'
14-
html_favicon = 'https://raw.githubusercontent.com/ansible/logos/main/vscode-ansible-logo/vscode-ansible.svg'
14+
html_logo = _logo
15+
html_favicon = _logo
1516
html_css_files = ['css/main.css']
1617
master_doc = 'index'
1718
display_version = True

0 commit comments

Comments
 (0)