Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ansible/galaxy-dev
Ansible Automation Hub
https://github.com/ansible/galaxy-dev
Last synced: about 2 months ago
JSON representation
Ansible Automation Hub
- Host: GitHub
- URL: https://github.com/ansible/galaxy-dev
- Owner: ansible
- Archived: true
- Created: 2019-06-18T11:31:43.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-23T20:10:33.000Z (over 4 years ago)
- Last Synced: 2024-06-02T04:35:37.652Z (4 months ago)
- Language: Dockerfile
- Homepage:
- Size: 84 KB
- Stars: 11
- Watchers: 12
- Forks: 13
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## DEPRECATED
Please visit the [Galaxy NextGen project](https://github.com/ansible/galaxy_ng)
# Automation Hub Backend
Backend project for Automation Hub. The frontend UI project is [ansible-hub-ui](https://github.com/ansible/ansible-hub-ui).
## OpenAPI Spec
View the latest version of the spec by [clicking here](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ansible/galaxy-api/master/openapi/openapi.yaml).
## Create a Local DEV Environment
To configure and run the API locally follow these steps:
1. Clone `galaxy-dev` repository
```
$ git clone [email protected]:ansible/galaxy-dev.git
```
2. Clone submodule
```
$ cd galaxy-dev/
$ git submodule update --init --remote
```
3. (Workaround) Checkout pulp_ansible version 0.2.0b3
```
$ cd pulp-ansible/
$ git checkout 0.2.0b3
```
4. Build development docker image
```
$ make docker/build
```
5. Run migrations
```
$ make docker/run-migrations
```
6. Run development environment
```
$ make docker/up
```
7. Create galaxy admin user
```
$ docker-compose run --rm galaxy-api manage createsuperuser
Username: admin
Password: admin
```
8. Create pulp admin user
**Note** If you want to use different user credentials, make sure pulp credentials
are updated in `galaxy-api/galaxy_api/settings.py`.
```
$ docker-compose run --rm pulp-api manage createsuperuser
Username: admin
Password: admin
```
9. Create pulp repository and distribution
```
$ docker-compose run --rm pulp-api manage shell
Python 3.6.8 (default, Aug 7 2019, 17:28:10)
[GCC 4.8.5 20150623 (Red Hat 4.8.5-39)] on linux
Type "help", "copyright", "credits" or "license" for more information.
(InteractiveConsole)
>>> from pulp_ansible.app.models import AnsibleRepository, AnsibleDistribution
>>> repo = AnsibleRepository.objects.create(name='automation-hub')
>>> AnsibleDistribution.objects.create(name='automation-hub', base_path='automation-hub', repository=repo)
>>> # Press to exit.
```
**Note** If the API is running without a UI, authorization can be disabled for testing
purposes by commenting default permission classes in `galaxy-api/galaxy_api/settings.py`
```
REST_FRAMEWORK = {
# ...
'DEFAULT_PERMISSION_CLASSES': [
# 'rest_framework.permissions.IsAuthenticated',
# 'galaxy_api.auth.auth.RHEntitlementRequired',
],
# ...
}
```
- Galaxy API URL: http://localhost:5001/api/automation-hub/v3/
- Galaxy admin site URL: http://localhost:5001/admin/
- Pulp API URL: http://localhost:5002/
## Running unit tests
To be able to run unit tests, database user permission to create a database need to be changed:
1. make sure you have the right permissions for Docker file volumes
2. open Postgres client from `pulp` Docker image: `docker-compose exec postgres psql -U postgres pulp`
3. give `galaxy` user permission to run `createdb`: `ALTER USER galaxy CREATEDB;`
To run unit tests:
1. install [`tox`](https://tox.readthedocs.io/en/latest/): `pip install --user tox`
2. run the unit tests: `galaxy-dev/galaxy-api/ $ tox -e py36,flake8`
## Running the UI Locally
For instructions on how to add the Automation Hub UI to your local environment, visit the [ansible-hub-ui frontend project](https://github.com/ansible/ansible-hub-ui).