Skip to content

Commit

Permalink
Readme files refresh
Browse files Browse the repository at this point in the history
  • Loading branch information
adziarnx authored and aleksinx committed Nov 3, 2021
1 parent edafcad commit 004e7b8
Show file tree
Hide file tree
Showing 10 changed files with 405 additions and 420 deletions.
400 changes: 0 additions & 400 deletions README

This file was deleted.

385 changes: 385 additions & 0 deletions README.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions appqos/ansible/intel/appqos/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# README for Ansible Collection - intel.appqos
May 2021
October 2021

## CONTENTS
- Introduction
Expand All @@ -26,7 +26,7 @@ Intel(R) RDT and Intel(R) SST to improve Quality of Service (QoS) for
applications via partitioning system resources.

More information can be found in App QoS README file available at:
https://github.com/intel/intel-cmt-cat/tree/master/appqos/README
https://github.com/intel/intel-cmt-cat/tree/master/appqos/README.md


## DEPENDENCIES
Expand Down Expand Up @@ -114,8 +114,8 @@ are located
Ansible scripts need CA certificate and a App QoS certificate located in a given
directory - those files will be copied to App QoS 'ca/' sub-directory in place where
App QoS has been installed. More info about certificate for the App QoS can be
found at https://github.com/intel/intel-cmt-cat/blob/master/appqos/README in
section 'APP QOS AND CLIENT CERTIFICATE'.
found at https://github.com/intel/intel-cmt-cat/blob/master/appqos/README.md in
section 'Creating evaluation mTLS certificate for testing'.

By default, App QoS is installed in '/opt/intel/appqos_workspace/appqos/'. At the
end of the playbook, App QoS should be up and running, listening on port 5000.
Expand Down
6 changes: 3 additions & 3 deletions appqos/docker/README
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
================================================================================
README for App QoS Docker container

June 2021
October 2021
================================================================================

CONTENTS
Expand Down Expand Up @@ -40,8 +40,8 @@ EOF

Now it is time to copy ca.crt, appqos.crt and appqos.key files for mutual TLS connection to
directory that we have just created. Instructions for creating certificate files for App QoS mTLS
connection can be found at: https://github.com/intel/intel-cmt-cat/blob/master/appqos/README in
section 'HOW TO GENERATE TEST APPQOS AND CLIENT CERTIFICATE'
connection can be found at: https://github.com/intel/intel-cmt-cat/blob/master/appqos/README.md in
section 'Creating evaluation mTLS certificate for testing'

When configuration file is prepared and certificate files are in place, the directory is ready to
be shared with the App QoS container:
Expand Down
4 changes: 2 additions & 2 deletions examples/c/CAT_MBA/README
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
================================================================================
README for CAT and MBA Sample Applications

August 2018
October 2021
================================================================================

CONTENTS
Expand All @@ -19,7 +19,7 @@ OVERVIEW
This is example code to demonstrate the use of PQoS/Intel(R) Resource Director
Technology (Intel(R) RDT) library APIs to manage Cache Allocation Technology
(CAT) and Memory Bandwidth Allocation (MBA).
Refer to https://github.com/01org/intel-cmt-cat/blob/master/README table 1
Refer to https://github.com/intel/intel-cmt-cat/blob/master/README table 1
for a list of processors supporting CAT and MBA. Each sample application
build will create five targets as follows:
1. allocation_app_l2cat - Demonstrates usage of PQoS/Intel(R) RDT library APIs
Expand Down
4 changes: 2 additions & 2 deletions examples/c/CMT_MBM/README
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
================================================================================
README for CMT MBM Sample Code

April 2016
October 2021
================================================================================

CONTENTS
Expand All @@ -19,7 +19,7 @@ OVERVIEW
This is example code to demonstrate the use of PQoS/Intel(R) Resource Director
Technology (Intel(R) RDT) library APIs to manage Cache Monitoring Technology
(CMT), Memory Bandwidth Monitoring (MBM). Refer to
https://github.com/01org/intel-cmt-cat/blob/master/README table 1 for a list
https://github.com/intel/intel-cmt-cat/blob/master/README table 1 for a list
of processors supporting CMT and MBM.
CMT_MBM sample application build will create one target as follows:
1. monitor_app - Demonstrates usage of PQoS/Intel(R) RDT library APIs related
Expand Down
2 changes: 1 addition & 1 deletion pqos/pqos.8
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ the MSR or OS/Kernel library interface to program the technologies.
Please see the -I option below for more information.
.PP
For hardware information please refer to the README located on:
https://github.com/01org/intel-cmt-cat/blob/master/README
https://github.com/intel/intel-cmt-cat/blob/master/README
.SH OPTIONS
pqos options are as follow:
.TP
Expand Down
4 changes: 2 additions & 2 deletions rpm/README
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
To build a RPM using our spec file please follow the instructions outlined on the following wiki:
https://github.com/01org/intel-cmt-cat/wiki/FAQ#how-do-i-build-and-install-from-a-rpm-spec-file
https://github.com/intel/intel-cmt-cat/wiki/FAQ#how-do-i-build-and-install-from-a-rpm-spec-file


Public location of our Fedora RPMs:
https://admin.fedoraproject.org/pkgdb/package/rpms/intel-cmt-cat/
https://src.fedoraproject.org/rpms/intel-cmt-cat


Other locations of where to find our RPMs:
Expand Down
8 changes: 4 additions & 4 deletions rpm/intel-cmt-cat.spec
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ License: BSD
Group: Development/Tools
ExclusiveArch: x86_64 i686 i586
%if %{defined githubsubver}
Source: https://github.com/01org/%{githubname}/archive/v%{githubver}.%{githubsubver}.tar.gz
Source: https://github.com/intel/%{githubname}/archive/v%{githubver}.%{githubsubver}.tar.gz
%else
Source: https://github.com/01org/%{githubname}/archive/v%{githubver}.tar.gz
Source: https://github.com/intel/%{githubname}/archive/v%{githubver}.tar.gz
%endif
URL: https://github.com/01org/%{githubname}
URL: https://github.com/intel/%{githubname}
BuildRequires: gcc, make

%description
Expand Down Expand Up @@ -80,7 +80,7 @@ and Code Data Prioratization (CDP).
The package includes library, header file and sample code.

For additional information please refer to:
https://github.com/01org/%{githubname}
https://github.com/intel/%{githubname}

%prep
%autosetup -n %{githubfull}
Expand Down
4 changes: 2 additions & 2 deletions snmp/README
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
========================================================================
README for rdt-agentx.pl Perl script

April 2016
October 2021
========================================================================


Expand Down Expand Up @@ -84,7 +84,7 @@ Or run snmpd from command line (e.g. for debugging purposes):
sudo snmpd -f -Dagentx -Lo -C --rwcommunity=pqos --master=agentx

And then run the rdt-agentx.pl script followed by the interface argument
-I [--iface-os] for OS interface
-I [--iface-os] for OS interface
No argument needed for MSR interface:
"sudo ./rdt-agentx.pl -I"
"sudo ./rdt-agentx.pl --iface-os"
Expand Down

0 comments on commit 004e7b8

Please sign in to comment.