Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix sphinx warnings #372

Merged
merged 6 commits into from
Oct 21, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions conu/apidefs/metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,11 @@ def __init__(self, name=None, identifier=None, labels=None, command=None,
:param image: Image, reference to Image instance
:param exposed_ports: list, list of exposed ports
:param port_mappings: dict, dictionary of port mappings {"container_port": [host_port1]},
example:
- {"1111/tcp":[1234, 4567]} bind host ports 1234 and 4567
to a single container port 1111/tcp

Example:

* {"1111/tcp":[1234, 4567]} bind host ports 1234 and 4567
to a single container port 1111/tcp
:param hostname: str, hostname
:param ipv4_addresses: dict, {address: port}
:param ipv6_addresses: dict, {address: port}
Expand Down
4 changes: 2 additions & 2 deletions conu/backend/docker/image.py
Original file line number Diff line number Diff line change
Expand Up @@ -231,8 +231,8 @@ def using_transport(self, transport=None, path=None, logs=True):
""" change used transport

:param transport: from where will be this image copied
:param path in filesystem
:param logs enable/disable
:param path: in filesystem
:param logs: enable/disable
:return: self
"""
if not transport:
Expand Down
6 changes: 4 additions & 2 deletions conu/backend/k8s/pod.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,11 @@ def __init__(self, namespace, name=None, spec=None, from_template=None):
:param namespace: str, namespace in which is pod created
:param name: name of pod
:param spec: pod spec
https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1PodSpec.md

* https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1PodSpec.md
:param from_template: str, pod template, example:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/#pod-templates

* https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/#pod-templates
"""
self.core_api = get_core_api()
self.namespace = namespace
Expand Down
20 changes: 10 additions & 10 deletions conu/backend/origin/backend.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@ def create_new_app_from_source(self, image_name, project=None,

def create_app_from_template(self, image_name, name, template, name_in_template,
other_images=None, oc_new_app_args=None, project=None):
"""
Helper function to create app from template
"""Helper function to create app from template

:param image_name: image to be used as builder image
:param name: name of app from template
:param template: str, url or local path to a template to use
Expand Down Expand Up @@ -222,8 +222,8 @@ def start_build(self, build, args=None):
raise ConuException("Cannot start build of application: %s" % e)

def get_image_registry_url(self, image_name):
"""
Helper function for obtain registry url of image from it's name
"""Helper function for obtain registry url of image from it's name

:param image_name: str, short name of an image, example:
- conu:0.5.0
:return: str, image registry url, example:
Expand All @@ -241,8 +241,8 @@ def get_image_registry_url(self, image_name):
return internal_registry_name.replace("'", "").replace('"', '')

def import_image(self, imported_image_name, image_name):
"""
Import image using `oc import-image` command.
"""Import image using `oc import-image` command.

:param imported_image_name: str, short name of an image in internal registry, example:
- hello-openshift:latest
:param image_name: full repository name, example:
Expand All @@ -264,8 +264,8 @@ def import_image(self, imported_image_name, image_name):
return imported_image_name

def request_service(self, app_name, port, expected_output=None):
"""
Make request on service of app. If there is connection error function return False.
"""Make request on service of app. If there is connection error function return False.

:param app_name: str, name of the app
:param expected_output: str, If not None method will check output returned from request
and try to find matching string.
Expand Down Expand Up @@ -296,9 +296,9 @@ def request_service(self, app_name, port, expected_output=None):
return False

def wait_for_service(self, app_name, port, expected_output=None, timeout=100):
"""
Block until service is not ready to accept requests,
"""Block until service is not ready to accept requests,
raises an exc ProbeTimeout if timeout is reached

:param app_name: str, name of the app
:param port: str or int, port of the service
:param expected_output: If not None method will check output returned from request
Expand Down
7 changes: 4 additions & 3 deletions docs/source/new_releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ How to release conu

We are using awesome `release-bot <(https://github.com/user-cont/release-bot>`_ for new conu releases.
If you want to make new release:
- create new issue in Github upstream repository with title ``x.y.z release`` and wait for release bot to create new PR.
- **polish CHANGELOG.md** and merge if tests are passing.
- Sit down, relax and watch how release bot is doing the hard work.

- create new issue in Github upstream repository with title ``x.y.z release`` and wait for release bot to create new PR.
- **polish CHANGELOG.md** and merge if tests are passing.
- Sit down, relax and watch how release bot is doing the hard work.