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

Added PSU util for Mellanox platforms, added PSU CLI to SNMP #1170

Merged
merged 7 commits into from
Dec 8, 2017
Merged
Show file tree
Hide file tree
Changes from 3 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
67 changes: 67 additions & 0 deletions device/mellanox/x86_64-mlnx_msn2100-r0/plugins/psuutil.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
#!/usr/bin/env python

#############################################################################
# Mellanox
#
# Module contains an implementation of SONiC PSU Base API and
# provides the PSUs status which are available in the platform
#
#############################################################################

import os.path

try:
from sonic_psu.psu_base import PsuBase
except ImportError, e:
raise ImportError (str(e) + "- required module not found")

class PsuUtil(PsuBase):
"""Platform-specific PSUutil class"""

def __init__(self):
PsuBase.__init__(self)

self.psu_path = "/sys/bus/i2c/devices/2-0060/"
self.psu_presence = "psu{}_status"
self.psu_oper_status = "psu{}_pg_status"

def get_num_psus(self):
"""
Retrieves the number of PSUs available on the device

:return: An integer, the number of PSUs available on the device
"""
return 2

def get_psu_status(self, index):
"""
Retrieves the oprational status of power supply unit (PSU) defined
by index <index>

:param index: An integer, index of the PSU of which to query status
Copy link
Collaborator

@qiluo-msft qiluo-msft Nov 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

index [](start = 15, length = 5)

Is it 1-based? Add some comment #Closed

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The base of index has been added.

:return: Boolean, True if PSU is operating properly, False if PSU is faulty
"""
if index is None:
return False

status = 0
try:
with open(self.psu_path + self.psu_oper_status.format(index), 'r') as power_status:
status = int(power_status.read())
except IOError:
return False

return status == 1

def get_psu_presence(self, index):
"""
Retrieves the presence status of power supply unit (PSU) defined
by index <index>

:param index: An integer, index of the PSU of which to query status
:return: Boolean, True if PSU is plugged, False if not
"""
if index and index > 0 and index <= self.get_num_psus():
Copy link
Collaborator

@qiluo-msft qiluo-msft Nov 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

index [](start = 11, length = 5)

isinstance(x, int) #Closed

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced with isinstance(index, int)

return True

return False
Copy link
Collaborator

@qiluo-msft qiluo-msft Nov 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

return index and index > 0 and index <= self.get_num_psus() #Closed

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed.

74 changes: 74 additions & 0 deletions device/mellanox/x86_64-mlnx_msn2410-r0/plugins/psuutil.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
#!/usr/bin/env python

#############################################################################
# Mellanox
#
# Module contains an implementation of SONiC PSU Base API and
# provides the PSUs status which are available in the platform
#
#############################################################################

import os.path

try:
from sonic_psu.psu_base import PsuBase
except ImportError, e:
raise ImportError (str(e) + "- required module not found")

class PsuUtil(PsuBase):
Copy link
Collaborator

@qiluo-msft qiluo-msft Nov 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PsuUtil [](start = 6, length = 7)

I see many code duplication in mellanox plugins. Is it possible to reduce them? Extract base class for mlnx? #Closed

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need a base class for Mellanox in Mellanox plugin ?
The base class won't be used anymore.

Copy link
Contributor

@jleveque jleveque Nov 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@qiluo-msft: I don't understand what you intend to accomplish here. Could you elaborate?

The base class is simply an abstract class that each platform-specific plugin should implement.

Copy link
Collaborator

@qiluo-msft qiluo-msft Nov 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(refine original comment) #Closed

"""Platform-specific PSUutil class"""

def __init__(self):
PsuBase.__init__(self)

self.psu_path = "/sys/bus/i2c/devices/2-0060/"
self.psu_presence = "psu{}_status"
self.psu_oper_status = "psu{}_pg_status"

def get_num_psus(self):
"""
Retrieves the number of PSUs available on the device

:return: An integer, the number of PSUs available on the device
"""
return 2

def get_psu_status(self, index):
"""
Retrieves the oprational status of power supply unit (PSU) defined
by index <index>

:param index: An integer, index of the PSU of which to query status
:return: Boolean, True if PSU is operating properly, False if PSU is faulty
"""
if index is None:
return False

status = 0
try:
with open(self.psu_path + self.psu_oper_status.format(index), 'r') as power_status:
status = int(power_status.read())
except IOError:
return False

return status == 1

def get_psu_presence(self, index):
"""
Retrieves the presence status of power supply unit (PSU) defined
by index <index>

:param index: An integer, index of the PSU of which to query status
:return: Boolean, True if PSU is plugged, False if not
"""
if index is None:
return False

status = 0
try:
with open(self.psu_path + self.psu_presence.format(index), 'r') as presence_status:
status = int(presence_status.read())
except IOError:
return False

return status == 1
74 changes: 74 additions & 0 deletions device/mellanox/x86_64-mlnx_msn2700-r0/plugins/psuutil.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
#!/usr/bin/env python
Copy link
Collaborator

@qiluo-msft qiluo-msft Nov 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly same file as msn2410. Please use a symbol link. #Closed

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced to a symbol link.


#############################################################################
# Mellanox
#
# Module contains an implementation of SONiC PSU Base API and
# provides the PSUs status which are available in the platform
#
#############################################################################

import os.path

try:
from sonic_psu.psu_base import PsuBase
except ImportError, e:
raise ImportError (str(e) + "- required module not found")

class PsuUtil(PsuBase):
"""Platform-specific PSUutil class"""

def __init__(self):
PsuBase.__init__(self)

self.psu_path = "/sys/bus/i2c/devices/2-0060/"
self.psu_presence = "psu{}_status"
self.psu_oper_status = "psu{}_pg_status"

def get_num_psus(self):
"""
Retrieves the number of PSUs available on the device

:return: An integer, the number of PSUs available on the device
"""
return 2

def get_psu_status(self, index):
"""
Retrieves the oprational status of power supply unit (PSU) defined
by index <index>

:param index: An integer, index of the PSU of which to query status
:return: Boolean, True if PSU is operating properly, False if PSU is faulty
"""
if index is None:
return False

status = 0
try:
with open(self.psu_path + self.psu_oper_status.format(index), 'r') as power_status:
status = int(power_status.read())
except IOError:
return False

return status == 1

def get_psu_presence(self, index):
"""
Retrieves the presence status of power supply unit (PSU) defined
by index <index>

:param index: An integer, index of the PSU of which to query status
:return: Boolean, True if PSU is plugged, False if not
"""
if index is None:
return False

status = 0
try:
with open(self.psu_path + self.psu_presence.format(index), 'r') as presence_status:
status = int(presence_status.read())
except IOError:
return False

return status == 1
74 changes: 74 additions & 0 deletions device/mellanox/x86_64-mlnx_msn2740-r0/plugins/psuutil.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
#!/usr/bin/env python

#############################################################################
# Mellanox
#
# Module contains an implementation of SONiC PSU Base API and
# provides the PSUs status which are available in the platform
#
#############################################################################

import os.path

try:
from sonic_psu.psu_base import PsuBase
except ImportError, e:
raise ImportError (str(e) + "- required module not found")

class PsuUtil(PsuBase):
"""Platform-specific PSUutil class"""

def __init__(self):
PsuBase.__init__(self)

self.psu_path = "/sys/bus/i2c/devices/2-0060/"
self.psu_presence = "psu{}_status"
self.psu_oper_status = "psu{}_pg_status"

def get_num_psus(self):
"""
Retrieves the number of PSUs available on the device

:return: An integer, the number of PSUs available on the device
"""
return 2

def get_psu_status(self, index):
"""
Retrieves the oprational status of power supply unit (PSU) defined
by index <index>

:param index: An integer, index of the PSU of which to query status
:return: Boolean, True if PSU is operating properly, False if PSU is faulty
"""
if index is None:
return False

status = 0
try:
with open(self.psu_path + self.psu_oper_status.format(index), 'r') as power_status:
status = int(power_status.read())
except IOError:
return False

return status == 1

def get_psu_presence(self, index):
"""
Retrieves the presence status of power supply unit (PSU) defined
by index <index>

:param index: An integer, index of the PSU of which to query status
:return: Boolean, True if PSU is plugged, False if not
"""
if index is None:
return False

status = 0
try:
with open(self.psu_path + self.psu_presence.format(index), 'r') as presence_status:
status = int(presence_status.read())
except IOError:
return False

return status == 1
8 changes: 5 additions & 3 deletions dockers/docker-snmp-sv2/Dockerfile.j2
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
FROM docker-config-engine

RUN echo 'deb [arch=amd64] http://packages.microsoft.com/repos/sonic-dev/ jessie main' >> /etc/apt/sources.list
Copy link
Collaborator

@qiluo-msft qiluo-msft Nov 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sonic-dev/ [](start = 63, length = 10)

Why you need sonic-dev repo? #Closed

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sonic-dev repo is necessary to download python-click and python-tabulate packages which are dependencies of sonic-utilities. This can all be removed in the future once this uses the PSU plugin directly (see my comment above).

Copy link
Collaborator

@qiluo-msft qiluo-msft Nov 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to install them by pip? #Closed

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, dependency issues arise when we have Debian packages that rely on Python packages and vice-versa (for example: sonic-net/sonic-utilities#124).


COPY [ \
{% for deb in docker_snmp_sv2_debs.split(' ') -%}
"debs/{{ deb }}",
Expand All @@ -22,9 +24,9 @@ ENV DEBIAN_FRONTEND=noninteractive
# TODO: remove libpython3.6-dev, its and pip's dependencies if we can get pip3 directly
# install subagent
# clean up
RUN apt-get update && apt-get install -y libperl5.20 libpci3 libwrap0 \
libexpat1-dev \
curl gcc && \
RUN apt-get update && apt-get install -y --force-yes libperl5.20 libpci3 libwrap0 \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why do we need force-yes?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was required by python click default group but I will double check and remove if no needed.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lguohan
It was required by following packets:
WARNING: The following packages cannot be authenticated!
python-click python-click-default-group python-tabulate
E: There are problems and -y was used without --force-yes

libexpat1-dev grub2-common bash-completion curl gcc \
Copy link
Collaborator

@qiluo-msft qiluo-msft Nov 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

grub2-common bash-completion [](start = 26, length = 28)

I think many dependencies are not needed if correctly refactored. If yes, please add a TODO comment. #Closed

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The added packets are required by sonic utilities.
The "TODO" comment is added.

python-pip python-click-default-group python-click python-natsort python-tabulate && \
dpkg -i \
{% for deb in docker_snmp_sv2_debs.split(' ') -%}
debs/{{ deb }}{{' '}}
Expand Down
2 changes: 1 addition & 1 deletion rules/docker-snmp-sv2.mk
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
DOCKER_SNMP_SV2 = docker-snmp-sv2.gz
$(DOCKER_SNMP_SV2)_PATH = $(DOCKERS_PATH)/docker-snmp-sv2
## TODO: remove LIBPY3_DEV if we can get pip3 directly
$(DOCKER_SNMP_SV2)_DEPENDS += $(SNMP) $(SNMPD) $(PY3) $(LIBPY3_DEV)
$(DOCKER_SNMP_SV2)_DEPENDS += $(SNMP) $(SNMPD) $(PY3) $(LIBPY3_DEV) $(SONIC_UTILS)
Copy link
Contributor

@jleveque jleveque Nov 21, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ultimately, there should be no need to install the sonic-utilities package in the SNMP docker. SNMP shouldn't rely on the CLI, but rather just the PSU plugin. However, the plugin bases currently live in the sonic-utilities repo. If we could move all of our Python modules into their own repo/Debian package (e.g., "sonic-python-modules"), we could simply install that package here, and wouldn't need to install all of the sonic-utilities dependencies.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jleveque @lguohan
From my point of view, the refactoring of sonic-utilities dependencies can be done separately as we need PSU feature available ASAP.
I use the psuutil CLI to avoid the code duplication. In case to use plugin directly, we need to copy ("duplicate") the logic for loading vendor and platform specific plugin to SNMP MIB implementation.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree we need this ASAP. This was simply intended as a comment to consider for the future. I did not intend for you to make this change now.

Copy link
Collaborator

@qiluo-msft qiluo-msft Nov 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If there is plan to refactor in near future, please add a TODO comment as above. #Closed

Copy link
Contributor

@jleveque jleveque Nov 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andrii-savka: FYI, from inside the SNMP docker, you would not need to duplicate the logic for loading vendor and platform specific plugin, because each docker container mounts the appropriate platform and hwsku directories to /usr/share/sonic/platform/ and /usr/share/sonic/hwsku/, respectively. Therefore, from inside the docker, you can simply load the plugin from /usr/share/sonic/platform/plugins.

I agree with Qi that you should add TODO comments as necessary so that we remember this future change.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jleveque @qiluo-msft
The "TODO" mark is added.
Regarding the plugin usage instead of CLI.
Currently, we can't avoid we sonic-utilities installing to SNMP docker because psu_base.py which required by vendor specific plugin is placed in sonic-util. repo.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyway, do we still need to use plugin directly from "/usr/share/sonic/platform/plugins/" instead of CLI in SNMP?

Copy link
Author

@andrii-savka andrii-savka Nov 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One of the main idea is that SNMP agent knows nothing about PSU implementation. It just uses a CLI to get a PSU status with no matter whether PSU CLI is plugin, C app or some other script.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed to use PSU plugin in SNMP with current dependencies.

$(DOCKER_SNMP_SV2)_PYTHON_WHEELS += $(ASYNCSNMP_PY3)
$(DOCKER_SNMP_SV2)_LOAD_DOCKERS += $(DOCKER_CONFIG_ENGINE)
SONIC_DOCKER_IMAGES += $(DOCKER_SNMP_SV2)
Expand Down