11 | {% include sidebar.html %}
12 |
16 |
13 | {{ content }}
14 |
15 |
2 |
5 |
--------------------------------------------------------------------------------
/docs/_layouts/page.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | ---
4 | {% if include.title %}{{ include.title }}{% else %}{{ include.type }}{% endif %}
3 |{{ include.content }}
4 |
5 |
6 | {{ content }}
7 | {% include toc.html %}
8 | {% include editable.html %}
9 |
10 |
11 |
--------------------------------------------------------------------------------
/django_oci/views/__init__.py:
--------------------------------------------------------------------------------
1 | # Load storage on application init
2 | from django_oci.storage import get_storage
3 |
4 | from .auth import GetAuthToken
5 | from .base import APIVersionCheck
6 | from .blobs import BlobDownload, BlobUpload
7 | from .image import ImageManifest, ImageTags
8 |
9 | storage = get_storage()
10 |
--------------------------------------------------------------------------------
/docs/_includes/tags.html:
--------------------------------------------------------------------------------
1 | {% if site.tag_search_endpoint %}{% if page.tags %}{% endif %}{% endif %}
3 |
--------------------------------------------------------------------------------
/tests/urls.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | from __future__ import absolute_import, unicode_literals
3 |
4 | from django.contrib import admin
5 | from django.urls import include, re_path
6 |
7 | urlpatterns = [
8 | re_path(r"^admin/", admin.site.urls),
9 | re_path(r"^", include("django_oci.urls", namespace="django_oci")),
10 | ]
11 |
--------------------------------------------------------------------------------
/docs/_layouts/post.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: page
3 | ---
4 |
5 | {{ page.title }}
6 | {% if page.badges %}{% for badge in page.badges %}{{ badge.tag }}{% endfor %}{% endif %} 7 | {{ page.date | date: "%B %d, %Y" }} 8 | {{ content }} 9 | -------------------------------------------------------------------------------- /docs/_includes/google-analytics.html: -------------------------------------------------------------------------------- 1 | {% if site.google-analytics %} 2 | {% endif %} 9 | -------------------------------------------------------------------------------- /manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | from __future__ import absolute_import, unicode_literals 4 | 5 | import os 6 | import sys 7 | 8 | if __name__ == "__main__": 9 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.settings") 10 | from django.core.management import execute_from_command_line 11 | 12 | execute_from_command_line(sys.argv) 13 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | * django-oci version: 2 | * Django version: 3 | * Python version: 4 | * Operating System: 5 | 6 | ### Description 7 | 8 | Describe what you were trying to get done. 9 | Tell us what happened, what went wrong, and what you expected to happen. 10 | 11 | ### What I Did 12 | 13 | ``` 14 | Paste the command(s) you ran and the output. 15 | If there was a crash, please include the traceback here. 16 | ``` 17 | -------------------------------------------------------------------------------- /docs/pages/usage-agreement.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Policy 3 | permalink: /policy/ 4 | --- 5 | 6 | # Policy 7 | 8 | ## License 9 | 10 | Usage of Django-OCI is governed by the terms of the [license]({{ site.repo }}/blob/master/LICENSE), which you should read and agree to before using the software. We encourage developers that create registries 11 | to ensure that their registries are [GDPR Compliant](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation). 12 | -------------------------------------------------------------------------------- /tests/wsgi.py: -------------------------------------------------------------------------------- 1 | """ 2 | WSGI config for example project. 3 | 4 | It exposes the WSGI callable as a module-level variable named ``application``. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/1.9/howto/deployment/wsgi/ 8 | """ 9 | 10 | import os 11 | 12 | from django.core.wsgi import get_wsgi_application 13 | 14 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.settings") 15 | 16 | application = get_wsgi_application() 17 | -------------------------------------------------------------------------------- /docs/_docs/storage/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Storage" 3 | pdf: true 4 | toc: true 5 | --- 6 | 7 | # Storage Options 8 | 9 | Django-OCI aims to have several storage backends as options to store containers. 10 | Currently, we start with just Filesystem support. 11 | 12 | ## Filesystem 13 | 14 | Filesystem support is the default storage option, and is intended for smaller 15 | registries that cannot use a possibly external resource like the cloud. You 16 | don't need to change any settings to use filesystem storage, as it is the default. 17 | -------------------------------------------------------------------------------- /docs/pages/sitemap.xml: -------------------------------------------------------------------------------- 1 | --- 2 | layout: null 3 | permalink: /sitemap.xml 4 | --- 5 | 6 | 7 |
9 |
10 |
17 |
18 | {% include footer.html %}
19 | {% include headers.html %}
20 | {% include tags.html %}
21 | {% include scrolltop.html %}
22 | {% include google-analytics.html %}
23 |
24 |
25 |
--------------------------------------------------------------------------------
/docs/pages/archive.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: page
3 | title: Articles
4 | permalink: /archive/
5 | ---
6 | # News Archive
7 |
8 | {% for post in site.posts %}{% capture this_year %}{{ post.date | date: "%Y" }}{% endcapture %}{% capture next_year %}{{ post.previous.date | date: "%Y" }}{% endcapture %}
9 |
10 | {% if forloop.first %}{{this_year}}
11 |- {% endif %}
12 |
- 13 | {{ post.date | date: "%b %-d, %Y" }}: {{ post.title }} 14 | {% if forloop.last %}
{{next_year}}
17 |- {% endif %}{% endif %}{% endfor %}
18 |
--------------------------------------------------------------------------------
/docs/_includes/social.html:
--------------------------------------------------------------------------------
1 |
24 |
--------------------------------------------------------------------------------
/docs/_posts/2020-10-12-hello-world.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Django-OCI Development"
3 | date: 2020-10-12 01:51:21 -0500
4 | categories: update
5 | badges:
6 | - type: success
7 | tag: update
8 | ---
9 |
10 | This is the first post to introduce a development version of Django-OCI!
11 | Currently, the library supports only filesystem storage for an OCI compliant registry.
12 | I hope to improve this project in the coming months with the following points.
13 |
14 |
15 |
16 | ## Interfaces
17 |
18 | I'd like to provide an example registry that also has interfaces to explore
19 | containers.
20 |
21 | ## Storage Backends
22 |
23 | It will be important to have support for more storage backends than the
24 | typical filesystem.
25 |
26 | ## Authentication
27 |
28 | Currently, there is no checking or authentication to interact with the registry,
29 | which won't fly in production. This needs to be added.
30 |
--------------------------------------------------------------------------------
/docs/Gemfile:
--------------------------------------------------------------------------------
1 | source "https://rubygems.org"
2 | ruby RUBY_VERSION
3 |
4 | # Hello! This is where you manage which Jekyll version is used to run.
5 | # When you want to use a different version, change it below, save the
6 | # file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
7 | #
8 | # bundle exec jekyll serve
9 | #
10 | # This will help ensure the proper Jekyll version is running.
11 | # Happy Jekylling!
12 | # gem "jekyll", "3.2.1"
13 |
14 | # This is the default theme for new Jekyll sites. You may change this to anything you like.
15 | # gem "minima"
16 |
17 | # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
18 | # uncomment the line below. To upgrade, run `bundle update github-pages`.
19 | gem "github-pages", group: :jekyll_plugins
20 |
21 | # If you have any plugins, put them here!
22 | # group :jekyll_plugins do
23 | # gem "jekyll-github-metadata", "~> 1.0"
24 | # end
25 |
--------------------------------------------------------------------------------
/django_oci/admin.py:
--------------------------------------------------------------------------------
1 | """
2 |
3 | Copyright (c) 2020-2023, Vanessa Sochat
4 |
5 | Licensed under the Apache License, Version 2.0 (the "License");
6 | you may not use this file except in compliance with the License.
7 | You may obtain a copy of the License at
8 |
9 | http://www.apache.org/licenses/LICENSE-2.0
10 |
11 | Unless required by applicable law or agreed to in writing, software
12 | distributed under the License is distributed on an "AS IS" BASIS,
13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | See the License for the specific language governing permissions and
15 | limitations under the License.
16 |
17 | """
18 |
19 | from django.contrib import admin
20 |
21 | from .models import Image, Repository
22 |
23 |
24 | @admin.register(Repository)
25 | class RepositoryAdmin(admin.ModelAdmin):
26 | pass
27 |
28 |
29 | @admin.register(Image)
30 | class ImageAdmin(admin.ModelAdmin):
31 | pass
32 |
--------------------------------------------------------------------------------
/django_oci/apps.py:
--------------------------------------------------------------------------------
1 | """
2 |
3 | Copyright (c) 2020-2023, Vanessa Sochat
4 |
5 | Licensed under the Apache License, Version 2.0 (the "License");
6 | you may not use this file except in compliance with the License.
7 | You may obtain a copy of the License at
8 |
9 | http://www.apache.org/licenses/LICENSE-2.0
10 |
11 | Unless required by applicable law or agreed to in writing, software
12 | distributed under the License is distributed on an "AS IS" BASIS,
13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | See the License for the specific language governing permissions and
15 | limitations under the License.
16 |
17 | """
18 |
19 | from django.apps import AppConfig
20 |
21 |
22 | class DjangoOciConfig(AppConfig):
23 | name = "django_oci"
24 | verbose_name = "Opencontainer Distribution specification for Django"
25 |
26 | def ready(self):
27 | import django_oci.signals
28 |
29 | assert django_oci.signals
30 |
--------------------------------------------------------------------------------
/tests/README.md:
--------------------------------------------------------------------------------
1 | ## Example Project for django_oci
2 |
3 | This example is provided as a convenience feature to allow potential users to
4 | try out Django OCI straight from the app repo without having to create a django project.
5 | It can also be used to develop django OCI in place.
6 |
7 | **Important** the secret key is hard coded into [settings.py](settings.py).
8 | You should obviously generate a new one for your project, and not add it to version control.
9 |
10 | To run this example, follow these instructions:
11 |
12 | 1. Navigate to the `tests/example` directory
13 | 2. Install the requirements for the package:
14 |
15 | ```bash
16 | pip install -r requirements.txt
17 | ```
18 |
19 | 3. Make and apply migrations
20 |
21 | ```bash
22 | python manage.py makemigrations
23 | python manage.py migrate
24 | ```
25 |
26 | 4. Run the server
27 |
28 | ```bash
29 | python manage.py runserver
30 | ```
31 |
32 | 5. Access from the browser at `http://127.0.0.1:8000`
33 |
--------------------------------------------------------------------------------
/docs/pages/news.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: News
3 | permalink: /news/
4 | ---
5 |
6 | # News
7 |
8 |
-
17 |
{{ post.title | xml_escape }} 18 |{{ post.content | xml_escape }} 19 |{{ post.date | date_to_rfc822 }} 20 | {{ post.url | prepend: site.baseurl | prepend: site.url }} 21 |{{ post.url | prepend: site.baseurl | prepend: site.url }} 22 | {% for tag in post.tags %} 23 |{{ tag | xml_escape }} 24 | {% endfor %} 25 | {% for cat in post.categories %} 26 |{{ cat | xml_escape }} 27 | {% endfor %} 28 |
29 | {% endfor %}
30 |
Subscribe with RSS to keep up with the latest news. 9 | For site changes, see the changelog kept with the code base.
10 | 11 | {% for post in site.posts limit:10 %} 12 |
13 |
15 | {% if post.badges %}{% for badge in post.badges %}{{ badge.tag }}{% endfor %}{% endif %} 16 | {{ post.content | split:'' | first }} 17 | {% if post.content contains '' %} 18 | read more 19 | {% endif %} 20 |
21 | {{ post.title }}
14 | {{ post.date | date: "%B %d, %Y" }}15 | {% if post.badges %}{% for badge in post.badges %}{{ badge.tag }}{% endfor %}{% endif %} 16 | {{ post.content | split:'' | first }} 17 | {% if post.content contains '' %} 18 | read more 19 | {% endif %} 20 |
22 | {% endfor %} 23 | 24 | Want to see more? See the News Archive. 25 | -------------------------------------------------------------------------------- /docs/_data/toc.yml: -------------------------------------------------------------------------------- 1 | - title: Introduction 2 | url: docs/introduction 3 | children: 4 | - title: About 5 | url: about 6 | - title: Background 7 | url: docs/introduction 8 | - title: Design 9 | url: docs/design 10 | - title: Frequently Asked Questions 11 | url: docs/faq 12 | - title: Policy 13 | url: policy 14 | - title: Getting Started 15 | url: docs/introduction 16 | children: 17 | - title: Install 18 | url: docs/getting-started/#install 19 | - title: Project Settings 20 | url: docs/getting-started/#project-settings 21 | - title: Customization Options 22 | url: docs/getting-started/options 23 | - title: Authentication 24 | url: docs/getting-started/auth 25 | - title: Example Project 26 | url: docs/getting-started/example 27 | - title: Example Client 28 | url: docs/getting-started/reggie 29 | - title: Testing 30 | url: docs/getting-started/testing 31 | - title: Storage 32 | url: docs/storage 33 | children: 34 | - title: Overview 35 | url: docs/storage 36 | - title: News 37 | url: news 38 | -------------------------------------------------------------------------------- /docs/search/search_index.json: -------------------------------------------------------------------------------- 1 | --- 2 | layout: null 3 | permalink: /search/search_index.json 4 | --- 5 | {"config":{"lang":["en"],"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{% for page in site.pages %}{% unless page.excluded_in_search %}{% if added %},{% endif %}{% assign added = false %}{"location": "{{ page.url }}", "text": "{{ page.content | strip_html | strip_newlines | slugify: 'ascii' | replace: '-', ' ' }}", "title": "{{ page.title }}"}{% assign added = true %}{% endunless %}{% endfor %}{% for post in site.posts %}{% unless page.excluded_in_search %}{% if added %},{% endif %}{% assign added = false %}{"location": "{{ post.url }}", "text": "{{ post.content | strip_html | strip_newlines | slugify: 'ascii' | replace: '-',' ' }}", "title": "{{ post.title }}"}{% assign added = true %}{% endunless %}{% endfor %}{% for doc in site.docs %}{% unless doc.excluded_in_search %}{% if added %},{% endif %}{% assign added = false %}{"location": "{{ doc.url }}", "text": "{{ doc.content | strip_html | strip_newlines | slugify: 'ascii' | replace: '-',' ' }}", "title": "{{ doc.title }}"}{% assign added = true %}{% endunless %}{% endfor %}]} 6 | -------------------------------------------------------------------------------- /docs/_docs/getting-started/example.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Example Project" 3 | pdf: true 4 | toc: true 5 | --- 6 | 7 | # Example Application 8 | 9 | You can develop or test interactively using the example (very simple) application 10 | under [tests](https://github.com/vsoch/django-oci/tree/master/tests). 11 | First create a virtual environment with the dependencies 12 | that you need: 13 | 14 | ```bash 15 | python -m venv env 16 | source env/bin/activate 17 | pip install -r requirements.txt 18 | ``` 19 | 20 | For development you can install the `django_oci` module locally: 21 | 22 | ```bash 23 | $ pip install -e . 24 | ``` 25 | 26 | The [manage.py](https://github.com/vsoch/django-oci/blob/master/manage.py) is located in the root directory 27 | so it's easy to update your install ad then interact with your test interface. 28 | 29 | ```bash 30 | python manage.py makemigrations django_oci 31 | python manage.py migrate django_oci 32 | python manage.py runserver 33 | ``` 34 | 35 | See the [tests](https://github.com/vsoch/django-oci/tree/master/tests) folder for more details, 36 | including how to start a development server. Examples will be added. 37 | -------------------------------------------------------------------------------- /docs/LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License 2 | 3 | Copyright (c) 2018-2019 Vanessa Sochat 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | This is a manually generated log to track changes to the repository for each release. 4 | Each section should include general headers such as **Implemented enhancements** 5 | and **Merged pull requests**. All closed issued and bug fixes should be 6 | represented by the pull requests that fixed them. 7 | Critical items to know are: 8 | 9 | - renamed commands 10 | - deprecated / removed commands 11 | - changed defaults 12 | - backward incompatible changes 13 | - migration guidance 14 | - changed behaviour 15 | 16 | ## [master](https://github.com/vsoch/django-oci/tree/master) 17 | - unpinning pyjwt version (0.0.17) 18 | - updating license headers 19 | - support for Django 4.0+ 20 | - Better tweak MANIFEST for upload to not include pycache (0.0.16) 21 | - Bug with filesystem save (saving without full image path) (0.0.15) 22 | - Adding mount and HEAD new endpoints for distribution spec (0.0.14) 23 | - View specific permission (pull,push) required (0.0.13) 24 | - Adding Django ratelimit to protect views (0.0.12) 25 | - Added authentication (0.0.11) 26 | - Django OCI core release without authentication (0.0.1) 27 | - skeleton release (0.0.0) 28 | -------------------------------------------------------------------------------- /docs/_docs/faq.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Frequently Asked Questions 3 | pdf: true 4 | toc: false 5 | --- 6 | 7 | # Frequently Asked Questions 8 | 9 | - [What is Django-OCI](#what-is-django-oci) 10 | - [What is a Linux Container?](#what-is-a-linux-container) 11 | 12 | 13 | ### What is Django OCI? 14 | 15 | Django-OCI is an open source registry that conforms to the opencontainers [distribution spec](https://github.com/opencontainers/distribution-spec). It is a Django module, meaning that Python developers that use Django can easily implement their own 16 | OCI compliant registries. 17 | 18 | ### What is a Linux Container? 19 | 20 | A container image is an encapsulated, portable environment that is created to distribute a scientific analysis or a general function. Containers help with reproducibility of such content as they nicely package software and data dependencies, along with libraries that are needed. Thus, the core of Singularity Hub are these Singularity container images, and by way of being on Singularity Hub they can be easily built, updated, referenced with a url for a publication, and shared. This small guide will help you to get started building your containers using Singularity Hub and your Github repositories. 21 | -------------------------------------------------------------------------------- /django_oci/views/base.py: -------------------------------------------------------------------------------- 1 | """ 2 | 3 | Copyright (c) 2020-2023, Vanessa Sochat 4 | 5 | Licensed under the Apache License, Version 2.0 (the "License"); 6 | you may not use this file except in compliance with the License. 7 | You may obtain a copy of the License at 8 | 9 | http://www.apache.org/licenses/LICENSE-2.0 10 | 11 | Unless required by applicable law or agreed to in writing, software 12 | distributed under the License is distributed on an "AS IS" BASIS, 13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | See the License for the specific language governing permissions and 15 | limitations under the License. 16 | 17 | """ 18 | 19 | from rest_framework.response import Response 20 | from rest_framework.views import APIView 21 | 22 | 23 | class APIVersionCheck(APIView): 24 | """provide version support information based on response statuses. 25 | This endpoint should only allow GET requests. 26 | https://github.com/opencontainers/distribution-spec/blob/master/spec.md#api-version-check 27 | """ 28 | 29 | permission_classes = [] 30 | allowed_methods = ("GET",) 31 | 32 | def get(self, request, *args, **kwargs): 33 | headers = {"Docker-Distribution-API-Version": "registry/2.0"} 34 | return Response({"success": True}, headers=headers) 35 | -------------------------------------------------------------------------------- /docs/pages/feed.xml: -------------------------------------------------------------------------------- 1 | --- 2 | layout: null 3 | permalink: /feed.xml 4 | --- 5 | 6 |
8 |
9 |
10 |
11 | 
12 |
13 | If you are looking to implement an opencontainers [distribution-spec](https://github.com/opencontainers/distribution-spec)
14 | registry using Django, you've come to the right place! Let's get started.
15 |
16 | # Getting Started
17 | These sections cover rationale, background, and frequently asked questions.
18 |
19 | - [About](about): a brief description of Django OCI.
20 | - [Introduction](docs/introduction): Covers some background and basic information.
21 | - [Frequenty Asked Questions](docs/faq): Quick answers to some questions you might have on your mind.
22 | - [Policy](docs/policy): including license and usage
23 |
24 |
25 | ## Usage
26 | These sections discuss installation, setting up and customizing a project, and storage options.
27 |
28 | - [Install](docs/getting-started): django-oci as a python module
29 | - [Project Settings](docs/getting-started/#project-settings): to add django-oci to your project
30 | - [Customization Options](docs/getting-started/options): to customize django-oci for your needs.
31 | - [Example Project](docs/getting-started/example): an example application to get started or test.
32 | - [Testing](docs/getting-started/testing): including project and conformance testing.
33 |
34 |
35 |
36 | Do you want a new feature? Is something not working as it should? @vsoch wants [your input!]({{ site.repo }}/issues).
37 |
--------------------------------------------------------------------------------
/docs/_includes/toc.html:
--------------------------------------------------------------------------------
1 |
5 |
6 |
36 |
--------------------------------------------------------------------------------
/docs/_includes/scrolltop.html:
--------------------------------------------------------------------------------
1 |
23 |
24 |
25 |
43 |
--------------------------------------------------------------------------------
/tests/test_conformance.py:
--------------------------------------------------------------------------------
1 | """
2 | test_django-oci api
3 | -------------------
4 |
5 | Tests for `django-oci` conformance
6 | """
7 |
8 | import os
9 | import subprocess
10 | import sys
11 | from time import sleep
12 |
13 | from rest_framework.test import APITestCase
14 |
15 | here = os.path.abspath(os.path.dirname(__file__))
16 |
17 | CONFORMANCE_BINARY_PATH = os.path.join(os.path.dirname(here), "conformance.test")
18 | SKIP_CONFORMANCE = os.environ.get("DJANGO_OCI_SKIP_CONFORMANCE")
19 |
20 |
21 | class ConformanceTests(APITestCase):
22 | def setUp(self):
23 | self.server_url = "127.0.0.1:8090"
24 | self.process = subprocess.Popen(
25 | ["python", "manage.py", "runserver", self.server_url]
26 | )
27 | sleep(2)
28 |
29 | def tearDown(self):
30 | os.kill(self.process.pid, 9)
31 |
32 | def test_conformance(self):
33 | """
34 | Given the conformance test binary exists, run tests
35 | """
36 | if not os.path.exists(CONFORMANCE_BINARY_PATH) and not SKIP_CONFORMANCE:
37 | sys.exit(
38 | "Conformance testing binary conformance.test not found, set DJANGO_OCI_SKIP_CONFORMANCE in environment to skip."
39 | )
40 |
41 | env = os.environ.copy()
42 | env["OCI_ROOT_URL"] = "http://" + self.server_url
43 | env["OCI_NAMESPACE"] = "vsoch/django-oci"
44 | env["OCI_DEBUG"] = "true"
45 | env["OCI_TEST_PUSH"] = "1"
46 | env["OCI_TEST_PULL"] = "1"
47 | env["OCI_TEST_CONTENT_DISCOVERY"] = "1"
48 | env["OCI_TEST_CONTENT_MANAGEMENT"] = "1"
49 |
50 | response = subprocess.call(CONFORMANCE_BINARY_PATH, env=env)
51 | self.assertEqual(response, 0)
52 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | # -*- coding: utf-8 -*-
3 | import os
4 | import re
5 |
6 | try:
7 | from setuptools import setup
8 | except ImportError:
9 | from distutils.core import setup
10 |
11 |
12 | def get_version(*file_paths):
13 | """Retrieves the version from django_oci/__init__.py"""
14 | filename = os.path.join(os.path.dirname(__file__), *file_paths)
15 | version_file = open(filename).read()
16 | version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M)
17 | if version_match:
18 | return version_match.group(1)
19 | raise RuntimeError("Unable to find version string.")
20 |
21 |
22 | version = get_version("django_oci", "__init__.py")
23 |
24 | with open("README.md") as fd:
25 | readme = fd.read()
26 |
27 | setup(
28 | name="django-oci",
29 | version=version,
30 | description="""Open Containers distribution API for Django""",
31 | long_description=readme,
32 | long_description_content_type="text/markdown",
33 | author="Vanessa Sochat",
34 | author_email="vsochat@stanford.edu",
35 | url="https://github.com/vsoch/django-oci",
36 | packages=[
37 | "django_oci",
38 | ],
39 | include_package_data=True,
40 | install_requires=["djangorestframework", "pyjwt", "django-ratelimit==3.0.0"],
41 | license="Apache Software License 2.0",
42 | zip_safe=False,
43 | keywords="django-oci",
44 | classifiers=[
45 | "Development Status :: 3 - Alpha",
46 | "Framework :: Django :: 1.11",
47 | "Framework :: Django :: 2.1",
48 | "Intended Audience :: Developers",
49 | "License :: OSI Approved :: BSD License",
50 | "Natural Language :: English",
51 | "Programming Language :: Python :: 3.7",
52 | ],
53 | )
54 |
--------------------------------------------------------------------------------
/docs/_docs/getting-started/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Getting Started"
3 | pdf: true
4 | toc: true
5 | ---
6 |
7 | # Getting Started
8 |
9 | ## Install
10 |
11 | You might first want to install django-oci:
12 |
13 | ```bash
14 | pip install django-oci
15 | ```
16 |
17 | you could also install a development version from GitHub:
18 |
19 | ```bash
20 | git clone https://github.com/vsoch/django-oci
21 | cd django-oci
22 |
23 | # To install to your python packages
24 | pip install .
25 |
26 | # To install from clone location
27 | pip install -e .
28 | ```
29 |
30 | This should install the one dependency, Django Rest Framework. If you want a requirements.txt
31 | file to do the same, one is provided in the repository.
32 |
33 | ```bash
34 | pip install -r reqiurements.txt
35 | ```
36 |
37 | ## Project Settings
38 |
39 | Add it to your `INSTALLED_APPS` along with `rest_framework`
40 |
41 | ```python
42 |
43 | INSTALLED_APPS = (
44 | ...
45 | 'django_oci',
46 | 'rest_framework',
47 | 'rest_framework.authtoken',
48 | ...
49 | )
50 | ```
51 |
52 | Add django-oci's URL patterns:
53 |
54 | ```python
55 |
56 | from django_oci import urls as django_oci_urls
57 | urlpatterns = [
58 | ...
59 | url(r'^', include(django_oci.urls)),
60 | ...
61 | ]
62 |
63 | ```
64 |
65 | You should also read about other [options]({{ site.baseurl }}/docs/getting-started/options)
66 | to provide in your project settings to customize the registry, and see the [example application]({{ site.baseurl }}/docs/getting-started/example)
67 | for an example of deployment. Details about authentication can be read about [here]({{ site.baseurl }}/docs/getting-started/auth). This will generate a distribution-spec set of API endpoints to generally push, pull,
68 | and otherwise interact with a registry. What is not (yet) provided are frontend
69 | interfaces to see your containers.
70 |
--------------------------------------------------------------------------------
/django_oci/signals.py:
--------------------------------------------------------------------------------
1 | """
2 |
3 | Copyright (c) 2020-2023, Vanessa Sochat
4 |
5 | Licensed under the Apache License, Version 2.0 (the "License");
6 | you may not use this file except in compliance with the License.
7 | You may obtain a copy of the License at
8 |
9 | http://www.apache.org/licenses/LICENSE-2.0
10 |
11 | Unless required by applicable law or agreed to in writing, software
12 | distributed under the License is distributed on an "AS IS" BASIS,
13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | See the License for the specific language governing permissions and
15 | limitations under the License.
16 |
17 | """
18 | from django.contrib.auth import get_user_model
19 | from django.db.models.signals import post_delete, post_save
20 | from django.dispatch import receiver
21 | from rest_framework.authtoken.models import Token
22 |
23 | from .models import Image
24 |
25 | UserModel = get_user_model()
26 |
27 |
28 | @receiver(post_delete, sender=Image)
29 | def delete_blobs(sender, instance, **kwargs):
30 | print("Delete image signal running.")
31 |
32 | for blob in instance.blobs.all():
33 | if hasattr(blob, "datafile"):
34 | if blob.image_set.count() == 0:
35 | print("Deleting %s, no longer used." % blob.datafile)
36 | blob.datafile.delete()
37 | blob.delete()
38 |
39 |
40 | @receiver(post_save, sender=UserModel)
41 | def create_auth_token(sender, instance=None, created=False, **kwargs):
42 | """Create a token for the user when the user is created (with oAuth2)
43 |
44 | 1. Assign user a token
45 | 2. Assign user to default group
46 |
47 | Create a Profile instance for all newly created User instances. We only
48 | run on user creation to avoid having to check for existence on each call
49 | to User.save.
50 | """
51 | if created:
52 | Token.objects.create(user=instance)
53 |
--------------------------------------------------------------------------------
/.github/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | Contributions are welcome, and they are greatly appreciated! Every
4 | little bit helps, and credit will always be given.
5 |
6 | You can contribute in many ways:
7 |
8 | ## Types of Contributions
9 |
10 | ### Report Bugs
11 |
12 | Report bugs at https://github.com/vsoch/django-oci/issues.
13 |
14 | If you are reporting a bug, please include:
15 |
16 | * Your operating system name and version.
17 | * Any details about your local setup that might be helpful in troubleshooting.
18 | * Detailed steps to reproduce the bug.
19 |
20 | ### Fix Bugs
21 | Look through the GitHub issues for bugs. Anything tagged with "bug"
22 | is open to whoever wants to implement it.
23 |
24 | ### Implement Features
25 |
26 | Look through the GitHub issues for features. Anything tagged with "feature"
27 | is open to whoever wants to implement it.
28 |
29 | ### Write Documentation
30 |
31 | django-oci could always use more documentation, whether as part of the
32 | official django-oci docs, in docstrings, or even on the web in blog posts,
33 | articles, and such.
34 |
35 | ### Submit Feedback
36 |
37 | The best way to send feedback is to file an issue at https://github.com/vsoch/django-oci/issues.
38 |
39 | If you are proposing a feature:
40 |
41 | * Explain in detail how it would work.
42 | * Keep the scope as narrow as possible, to make it easier to implement.
43 | * Remember that this is a volunteer-driven project, and that contributions
44 | are welcome :)
45 |
46 | ## Pull Request Guidelines
47 |
48 | Before you submit a pull request, check that it meets these guidelines:
49 |
50 | 1. The pull request should include tests.
51 | 2. If the pull request adds functionality, the docs should be updated. Put
52 | your new functionality into a function with a docstring, and add the
53 | feature to the list in README.rst.
54 | 3. The pull request should work for minimally Python 3.5 and for PyPy.
55 |
--------------------------------------------------------------------------------
/docs/_includes/editable.html:
--------------------------------------------------------------------------------
1 |
4 |
5 |
34 |
60 |
--------------------------------------------------------------------------------
/django_oci/views/parsers.py:
--------------------------------------------------------------------------------
1 | """
2 |
3 | Copyright (c) 2020-2023, Vanessa Sochat
4 |
5 | Licensed under the Apache License, Version 2.0 (the "License");
6 | you may not use this file except in compliance with the License.
7 | You may obtain a copy of the License at
8 |
9 | http://www.apache.org/licenses/LICENSE-2.0
10 |
11 | Unless required by applicable law or agreed to in writing, software
12 | distributed under the License is distributed on an "AS IS" BASIS,
13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | See the License for the specific language governing permissions and
15 | limitations under the License.
16 |
17 | """
18 |
19 | from rest_framework import renderers
20 | from rest_framework.negotiation import BaseContentNegotiation
21 |
22 |
23 | class IgnoreClientContentNegotiation(BaseContentNegotiation):
24 | """Important! This class is not used, however if you want to validate
25 | (or allow) any media type (e.g., the server doesn't return 406) you
26 | can set this as the default content negotiation for any view.
27 |
28 | content_negotiation_class = IgnoreClientContentNegotiation
29 | """
30 |
31 | def select_parser(self, request, parsers):
32 | """Return the first parser (usually application/json)"""
33 | return parsers[0]
34 |
35 | def select_renderer(self, request, renderers, format_suffix):
36 | """Return the first renderer (usually application/json)"""
37 | return (renderers[0], renderers[0].media_type)
38 |
39 |
40 | class ManifestRenderer(renderers.BaseRenderer):
41 | """A ManifestRenderer is provided to the ImageManifest views, which need
42 | to accept a content type for the image manifest. Without this
43 | renderer, Django will return 406
44 | """
45 |
46 | media_type = "application/vnd.oci.image.manifest.v1+json"
47 | format = None
48 | charset = None
49 | render_style = "binary"
50 |
51 | def render(self, data, media_type=None, renderer_context=None):
52 | return data
53 |
--------------------------------------------------------------------------------
/docs/_includes/head.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
12 | 31 | 32 | # Goals 33 | 34 | While still in early in development, django-oci aims to meet the following goals: 35 | 36 | - provide a registry that conforms to the distribution-spec, passing conformance testing 37 | - make customization easy for the developer user 38 | - provide numerous storage backends 39 | 40 | Most of these are still under development! If you'd like to help, please [let us know!]({{site.repo}}/issues). 41 | -------------------------------------------------------------------------------- /docs/_docs/design.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Design 3 | pdf: true 4 | toc: false 5 | --- 6 | 7 | # Design 8 | 9 | This document aims to answer questions about design. There is some leeway with respect 10 | to how the models are designed. 11 | 12 | ## Models 13 | 14 | In the case that we have repositories, blobs, and image manifests that connect the two, 15 | you could imagine a design that has blobs shared between images and repositories, or one 16 | that is more redundant to keep a storage namespace based on repositories, that way no two 17 | repositories can share the exact same blob. Or more specifically: 18 | 19 | - Having blobs linked 1:1 to a repository, and then referenced in Image Manifests only belonging to that repository (you wouldn't need to worry about blob sharing across repositories, and cleanup would be limited to ensuring the blob only isn't needed by the repository in question) 20 | - Having blobs linked to Image Manifests, which are linked to Repositories. 21 | - Having blobs not linked to any Image Manifest or Repository and shared amongst all blobs (and for this implementation idea you would need to ensure that blobs are not deleted that are still being used, and that there aren't any security loopholes with someone uploading a blob that would be used by another repository. 22 | 23 | While the last design is more space efficient, is does potentially introduce security and cleanup 24 | issues when sharing blobs. For this reason, we choose the second design - by way of the distribution-spec 25 | having the repository name as a parameter to most requests, we can easily link each of blobs and Image manifests 26 | to a repository directly. For more detail about the distribution-spec, we recommend that you look 27 | at the [distribution-spec repository](https://github.com/opencontainers/distribution-spec/). 28 | The remainder of this section briefly discusses models. 29 | 30 | ### Repository 31 | 32 | A repository is a namespace like `myorg/myrepo` that has one or more image manifests, 33 | or lists of blobs associated with a set of metadata. A repository will be owned by a user, 34 | and optionally have additional contributors, and finally, be optionally private. 35 | These last set of features are not yet implemented. 36 | 37 | ## Images 38 | 39 | An image model is technically referring to an image manifest. This means it points to one 40 | or more blobs, and has metadata about an image. The image manifest itself is stored in the 41 | exact same byte stream as it's provided (BinaryField), and the blobs and annotations are extracted 42 | after parsing from string to json. An image (manifest) is also directly linked (or owned) 43 | by a repository, and each manifest has a many to many relationship to point to one or more blobs 44 | 45 | ## Blobs 46 | 47 | A blob is a binary (a FileField) along with a content type that is uploaded by a client. 48 | The general workflow for a push is to provide a set of blobs associated with an image manifest 49 | and repository. For the implementation here, we link blobs off the bat with a repository (and 50 | storage honors this structure as well) and then either use POST, PUT, or PATCH to do a monolithic 51 | or chunked upload. Blobs are then referenced in image manifests and can be requested for pull 52 | by an oci compliant client. To eventually support remote file storage, blobs have both a datafile 53 | (FileField) and a remotefile that would allow for a remote address (not yet used). 54 | 55 | ## Tag 56 | 57 | A tag is typically a small string to describe a version of a manifest, e.g., "latest." 58 | Tags fall under the general description of a "digest" which can also include a sha256 sum. 59 | In the case of the implementation here, Tags are represented in their own table, and 60 | have fields for a name, and then a foreign key to a particular image. This means 61 | that one image can have more than one tag, and tags are not shared between images. 62 | 63 | ## Annotation 64 | 65 | Akin to a tag, an annotation also stores a foreign key to a particular image, but 66 | instead of just a name, we hold a key and value pair. For both these strategies, while 67 | it might be redundant to store "the same" tag or annotation for different repositories, 68 | this approach is taken to mirror the design choice to not have shared model instances 69 | between repositories. This design choice could of course change if there is compelling 70 | reason. 71 | -------------------------------------------------------------------------------- /docs/_includes/navigation.html: -------------------------------------------------------------------------------- 1 | 6 | 7 | 8 | 9 | Skip to content 10 |